MCP Server

MCP 服务

一个用于创建 Model Context Protocol (MCP) 服务的 TypeScript 模板仓库，同时支持 stdio（标准输入/输出）和 SSE（服务器发送事件）传输方式。此模板为构建 MCP 服务提供了坚实基础，结构清晰，并包含必备功能。

功能

• 🚀 使用 TypeScript 构建，提供类型安全和更好的开发体验
• 🔄 支持 stdio 和 SSE 两种传输方式
• 📦 包含示例提示词、资源和工具
• ⚡ 使用 FastMCP 加速开发

前置条件

• Node.js
• npm 或 yarn 包管理器

开始使用

1. 基于此模板创建仓库

   点击 Use this template > Create a new repository

   

2. 克隆你的仓库

   git clone https://github.com/iamtraction/node-mcp-server.git
   cd node-mcp-server
   

3. 安装依赖

   npm install
   

4. 启动开发服务器

   npm run dev
   

项目结构

src/
├── prompts/     # MCP prompts
├── resources/   # MCP resources
├── tools/       # MCP tools
└── server.ts    # Main server file

可用脚本

• npm run dev - 启动开发服务器并启用热重载
• npm run build - 构建 TypeScript 代码
• npm run start - 启动生产服务器
• npm run watch - 监视 TypeScript 变更
• npm run lint - 运行 ESLint，检查代码质量和风格

添加新功能

添加提示词

在 src/prompts/ 中创建新文件，并将其添加到 server.ts。了解更多关于 MCP 提示词的信息：

import myPrompt from "./prompts/my-prompt.js";
server.addPrompt(myPrompt);

添加资源

在 src/resources/ 中创建新文件，并将其添加到 server.ts。了解更多关于 MCP 资源的信息：

import myResource from "./resources/my-resource.js";
server.addResource(myResource);

添加工具

在 src/tools/ 中创建新文件，并将其添加到 server.ts。了解更多关于 MCP 工具的信息：

import myTool from "./tools/my-tool.js";
server.addTool(myTool);

配置

可以在 server.ts 中配置服务。默认情况下，它使用 SSE 传输方式并运行在端口 3000 上。你可以在 server.start() 选项中修改配置：

server.start({
    transportType: "httpStream", // or "stdio"
    httpStream: {
        port: 3000,
    },
});

了解更多关于传输方式的信息。

使用 MCP 服务

stdio 服务设置

{
    "mcpServers": {
        "example-server": {
            "command": "node",
            "args": [ "dist/server.js" ]
         }
    }
}

SSE 服务设置

{
    "mcpServers": {
        "example-server": {
            "url": "https://example-server.com/sse"
         }
    }
}

贡献

欢迎贡献！欢迎提交 Pull Request。

展示

你是否用此模板构建了有趣的项目？将它添加到展示列表中吧！

将你的项目添加到展示列表：

1. 编辑此 README.md 文件
2. 按照以下格式将项目添加到上方列表：

   - [Your Project Name](link-to-your-project) - 简要描述
   

3. 提交 pull request

许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

致谢

• Model Context Protocol - 协议规范
• MCP TypeScript SDK - 官方 TypeScript SDK
• FastMCP - 底层 MCP 框架