Skip to content

Improve initial project structure and documentation#1

Merged
sofabeat merged 2 commits into
mainfrom
feature/at-publish-npm
Mar 30, 2026
Merged

Improve initial project structure and documentation#1
sofabeat merged 2 commits into
mainfrom
feature/at-publish-npm

Conversation

@sofabeat
Copy link
Copy Markdown
Contributor

  • Implement session management in HTTP server with activity tracking
  • Refactor setup to dynamically use package version
  • Update .env.example for environment variable configuration
  • Implement GitHub Actions workflow for release and publish
  • Update .gitignore to include additional files
  • Add CHANGELOG.md for version tracking
  • Create CONTRIBUTING.md to guide contributors
  • Add LICENSE.md for project licensing
  • Enhance README.md with detailed installation and usage instructions
  • Introduce SECURITY.md for vulnerability reporting
  • Develop DEVELOPMENT.md for setup and testing guidelines
  • Update package.json with repository and publishing details

- Implement session management in HTTP server with activity tracking
- Refactor setup to dynamically use package version
- Update .env.example for environment variable configuration
- Implement GitHub Actions workflow for release and publish
- Update .gitignore to include additional files
- Add CHANGELOG.md for version tracking
- Create CONTRIBUTING.md to guide contributors
- Add LICENSE.md for project licensing
- Enhance README.md with detailed installation and usage instructions
- Introduce SECURITY.md for vulnerability reporting
- Develop DEVELOPMENT.md for setup and testing guidelines
- Update package.json with repository and publishing details
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the project’s packaging, documentation, and release readiness, while adding HTTP session activity tracking/cleanup and aligning the MCP server version with package.json.

Changes:

  • Added HTTP session activity tracking with idle-session cleanup.
  • Refactored MCP server setup to pull the version from package.json.
  • Expanded repository metadata: scoped npm package config, release workflow, and additional project docs (README/SECURITY/DEVELOPMENT/CONTRIBUTING/LICENSE/CHANGELOG), plus minor repo hygiene updates.

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
src/server/setup.ts Sets MCP server version dynamically from package.json.
src/server/http.ts Adds session lastActivity tracking and TTL-based cleanup for HTTP sessions.
package.json Updates package name to @platfone/mcp and adds publishing/repo metadata.
docs/DEVELOPMENT.md Adds detailed local dev/test instructions.
SECURITY.md Adds a vulnerability reporting policy.
README.md Restructures and shortens README, pointing to dedicated docs.
LICENSE.md Adds MIT license file.
CONTRIBUTING.md Adds contributor guidelines.
CHANGELOG.md Introduces changelog and notes key capabilities.
.gitignore Adds additional ignored files/dirs.
.github/workflows/release.yml Adds a manual release/publish workflow.
.env.example Updates sandbox configuration comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/release.yml Outdated
Comment thread src/server/http.ts Outdated
Comment thread README.md Outdated
Comment thread src/server/http.ts
Comment thread src/server/http.ts
Comment thread src/server/http.ts Outdated
Comment thread src/server/http.ts
…ting

- fix setInterval is never cleared/unref’d
- validate stricter semver for TAG
@sofabeat sofabeat requested a review from Vitold55 March 27, 2026 08:05
@sofabeat sofabeat merged commit 58543bf into main Mar 30, 2026
1 check passed
@sofabeat sofabeat deleted the feature/at-publish-npm branch March 30, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants