MCP服务器模板

MCP服务器

用于创建的TypeScript模板存储库 模型上下文协议（MCP） 支持stdio（标准输入/输出）和SSE（服务器发送事件）传输的服务器。该模板为构建具有良好组织结构和基本功能的MCP服务器提供了坚实的基础。

特性

• 🚀 使用TypeScript构建，实现类型安全和更好的开发人员体验
• 🔄 支持stdio和SSE 运输
• 📦 包括示例提示、资源和工具
• ⚡ 用途 FastMCP 为了快速发展

先决条件

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

入门指南

1. 基于此模板创建仓库

   点击 使用此模板 > 创建新仓库

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"
         }
    }
}

贡献

欢迎投稿！请随时提交拉取请求。

展示

你用这个模板做了什么很酷的东西吗？将其添加到展示中！

要将您的项目添加到展示中，请执行以下操作：

1. 编辑此README.md文件
2. 使用以下格式将您的项目添加到上面的列表中：
   复制

   - [Your Project Name](link-to-your-project) - Brief description
   

3. 提交拉取请求

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

• 模型上下文协议 -协议规范
• MCP TypeScript SDK -TypeScript官方SDK
• FastMCP -基础MCP框架