mcp-framework
The Typescript MCP Framework
File Explorer
Download Latest Version (.zip)- mcp-framework.mdc
- release.yml
- caching.md
- cli.md
- custom-adapters.md
- fumadocs-setup.md
- overview.md
- satp-agent-trust.md
- server.md
- sources.md
- tools.md
- README.md
- TICKET-00-sdk-upgrade.md
- TICKET-01-origin-validation.md
- TICKET-02-protocol-version-header.md
- TICKET-03-localhost-binding.md
- TICKET-04-title-icons.md
- TICKET-05-tool-annotations.md
- TICKET-06-structured-content.md
- TICKET-07-audio-content.md
- TICKET-08-resource-links-embedded.md
- TICKET-09-content-annotations.md
- TICKET-10-logging-protocol.md
- TICKET-11-progress-tracking.md
- TICKET-12-cancellation.md
- TICKET-13-elicitation-form.md
- TICKET-14-roots-support.md
- TICKET-15-sampling-with-tools.md
- TICKET-16-tasks.md
- TICKET-17-elicitation-url-mode.md
- apps.md
- IMPLEMENTATION_PLAN.md
- introduction.md
- OAUTH.md
- resources.md
- SPEC_AUDIT.md
- SecureDataTool.ts
- index.ts
- proxy-server.ts
- .env.example
- .gitignore
- package-lock.json
- package.json
- README.md
- tsconfig.json
- cognito-oauth-claude-ai.ts
- cognito-oauth-simple.ts
- oauth-cognito-example.ts
- oauth-custom-validator.ts
- oauth-simple-example.ts
- oauth-test-client.ts
- README-COGNITO.md
- README.md
- index.ts
- memory-cache.ts
- types.ts
- env.example.template
- index.ts.template
- package.json.template
- README.md.template
- tsconfig.json.template
- create-docs-mcp.ts
- create-docs-server.ts
- fumadocs-remote.ts
- index.ts
- llms-txt-parser.ts
- llms-txt.ts
- types.ts
- GetPageTool.ts
- index.ts
- ListSectionsTool.ts
- SearchDocsTool.ts
- tokens.ts
- errors.ts
- index.ts
- server.ts
- env.example.template
- index.ts.template
- package.json.template
- README.md.template
- tsconfig.json.template
- fumadocs-search-response.json
- llms-full-txt-simple.txt
- llms-txt-empty.txt
- llms-txt-malformed.txt
- llms-txt-simple.txt
- fumadocs-remote-e2e.test.ts
- server-lifecycle.test.ts
- memory-cache.test.ts
- fumadocs-remote.test.ts
- llms-txt-parser.test.ts
- llms-txt.test.ts
- get-page.test.ts
- list-sections.test.ts
- search-docs.test.ts
- jest.config.js
- package.json
- README.md
- SKILL.md.template
- tsconfig.json
- BaseApp.ts
- types.ts
- validation.ts
- protected-resource.ts
- apikey.ts
- jwt.ts
- oauth.ts
- satp.ts
- introspection-validator.ts
- jwt-validator.ts
- index.ts
- types.ts
- validate.ts
- build-cli.ts
- build.ts
- add-app.ts
- add-prompt.ts
- add-resource.ts
- add-tool.ts
- create.ts
- react-app.ts
- readme.ts
- string-utils.ts
- validate-project.ts
- index.ts
- Logger.ts
- MCPServer.ts
- TaskManager.ts
- appLoader.ts
- BaseLoader.ts
- promptLoader.ts
- resourceLoader.ts
- toolLoader.ts
- BasePrompt.ts
- BaseResource.ts
- index.ts
- lambda-adapter.ts
- types.ts
- web-auth-handler.ts
- BaseTool.ts
- README.md
- server.ts
- types.ts
- server.ts
- types.ts
- server.ts
- auth-handler.ts
- image-handler.ts
- oauth-metadata.ts
- origin-validator.ts
- ping-message.ts
- base.ts
- fileDiscovery.ts
- headers.ts
- requestContext.ts
- index.ts
- BaseApp.test.ts
- BaseTool.app.test.ts
- react-templates.test.ts
- validation.test.ts
- protected-resource.test.ts
- oauth.test.ts
- introspection-validator.test.ts
- jwt-validator.test.ts
- cli-version.test.ts
- create-current-dir.test.ts
- ticket-018-serverless-bc-auth.test.ts
- ticket-018-serverless-bc-exports.test.ts
- ticket-018-serverless-bc-init.test.ts
- ticket-018-serverless-bc-mcpserver.test.ts
- ticket-018-serverless-bc-transport.test.ts
- completions.test.ts
- cancellation.test.ts
- elicitation.test.ts
- logging-protocol.test.ts
- multi-transport-config.test.ts
- multi-transport-lifecycle.test.ts
- progress.test.ts
- roots.test.ts
- tasks.test.ts
- elicitation.e2e.test.ts
- ticket-004-cors-compat.e2e.test.ts
- ticket-124-multi-transport-compat.e2e.test.ts
- EchoTool.ts
- mock-auth-server.ts
- BaseLoader-path-resolution.test.ts
- BaseLoader.test.ts
- fileDiscovery.test.ts
- promptLoader.test.ts
- resourceLoader.test.ts
- toolLoader.test.ts
- tsx-support.test.ts
- list-resources.test.ts
- lambda-adapter.test.ts
- lambda-e2e.test.ts
- web-auth-handler.test.ts
- BaseTool.test.ts
- content-types.test.ts
- elicitation.test.ts
- inject-server-parity.test.ts
- nested-schema-validation.test.ts
- sampling-tools.test.ts
- schema-validation.test.ts
- structured-content.test.ts
- tool-annotations.test.ts
- tool-metadata.test.ts
- cors-consistency.test.ts
- server-oauth.test.ts
- server-session-resilience.test.ts
- server.test.ts
- server-oauth.test.ts
- health-endpoint.test.ts
- host-binding.test.ts
- origin-validation.test.ts
- README.md
- .editorconfig
- .env.claude-ai
- .env.example.cognito
- .gitignore
- .prettierrc
- .release-please-config.json
- .release-please-manifest.json
- CHANGELOG.md
- CHANGES.md
- CLAUDE.md
- complete-merge.sh
- eslint.config.js
- jest.config.js
- LICENSE
- merge-oauth.sh
- MERGE_OAUTH_WITH_HTTPSTREAM.md
- OAUTH_GUIDE.md
- OAUTH_IMPLEMENTATION_PLAN.md
- OAUTH_IMPLEMENTATION_SUMMARY.md
- OAUTH_QUICK_START.md
- OAUTH_USER_STORY.md
- package-lock.json
- package.json
- PERFORMANCE_REPORT.md
- README.md
- SECURITY_AUDIT.md
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/QuantGeekDev/mcp-framework
Downloads the entire project code from GitHub to your computer.
cd mcp-framework
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Node.js Node.js must be installed to use npm.
npm install -g mcp-framework
Installs the package published on the npm registry globally β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Node.js
EasyPrerequisites
npm install -g mcp-framework
Installs the package published on the npm registry globally β no need to clone the source.
npm run build
Builds optimized production files.
MCP_SKIP_TOOL_VALIDATION=false npm run build # Force validation (default)
Builds optimized production files.
MCP_SKIP_TOOL_VALIDATION=true npm run build # Skip validation (not recommended)
Builds optimized production files.
"prepack": "npm run build && mcp validate"
Builds optimized production files.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)