使用说明
MCP服务器
模型上下文协议(MCP)服务器的集合,用于将外部系统与人工智能助手(如Claude Desktop、Cursor、VS Code和其他MCP兼容客户端)集成。
概述
此存储库提供:
- 模板:用于构建MCP服务器的生产就绪模板
- 命令行界面:快速创建新服务器的脚手架工具
- 服务器:单个MCP服务器实现
快速开始
1.设置
# Install CLI dependencies
npm run setup
2.创建新服务器
npm run create-server
这将提示您:
- 服务器名称(例如。,
github,slack,jira) - 描述
- 作者
将在中创建新服务器 servers/mcp-server-{name}/.
3.开发您的服务器
cd servers/mcp-server-{name}
# Install dependencies (if not done during creation)
npm install
# Start development server
npm run dev
存储库结构
mcp-servers/
├── cli/ # CLI scaffolding tool
│ └── src/
├── template/ # Server template
│ ├── src/
│ │ ├── tools/ # MCP tools
│ │ ├── resources/ # MCP resources
│ │ ├── prompts/ # MCP prompts
│ │ └── ...
│ ├── Dockerfile
│ └── ...
├── servers/ # Created MCP servers
│ ├── mcp-server-github/
│ │ ├── icon.png # 512x512 server icon
│ │ └── ...
│ ├── mcp-server-slack/
│ └── ...
├── CLAUDE.md # AI coding standards
└── package.json
服务器图标
每个MCP服务器应包括 512x512 PNG图标 命名 icon.png 在服务器的根目录中。MCP Hub和其他MCP兼容客户端使用此图标在其UI中显示服务器。
servers/mcp-server-{name}/
├── icon.png # Required: 512x512 PNG icon
├── src/
├── package.json
└── ...
图标要求:
- 格式:PNG
- 大小:512x512像素
- 文件名:
icon.png - 位置:服务器目录的根目录
MCP概念
| 概念 | 描述 | 用例 |
|---|---|---|
| 工具 | 执行操作的操作 | 创建问题、发送消息、执行命令 |
| 资源 | 只读数据访问 | 获取用户配置文件,列出存储库 |
| 鼓励 | 可重用AI模板 | 代码审查提示、摘要模板 |
服务器功能
每台服务器包括:
- ✅ 具有严格类型检查的TypeScript
- ✅ 双传输(STDIO+HTTP/SSE)
- ✅ Docker支持多阶段构建
- ✅ ESLint+预处理配置
- ✅ Vitest测试设置
- ✅ GitHub操作CI管道
- ✅ 基于环境的配置
开发工作流程
添加工具
// src/tools/my-tool.tool.ts
import { z } from "zod";
import { server } from "../server.js";
server.tool(
"my_tool",
z.object({ param: z.string() }),
async ({ param }) => ({
content: [{ type: "text", text: `Result: ${param}` }],
})
);
添加资源
// src/resources/my-resource.resource.ts
import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { server } from "../server.js";
server.resource(
"my_resource",
new ResourceTemplate("resource://{id}", { list: undefined }),
async (uri, { id }) => ({
contents: [{ uri: uri.href, text: `Data for ${id}` }],
})
);
与Claude Desktop一起使用
将您的服务器添加到Claude Desktop的配置中:
{
"mcpServers": {
"my-server": {
"command": "node",
"args": ["/path/to/servers/mcp-server-my/build/index.js"]
}
}
}
Docker部署
每个服务器都可以使用Docker进行部署:
cd servers/mcp-server-my
# Build image
docker build -t mcp-server-my .
# Run container
docker run -p 3000:3000 --env-file .env mcp-server-my
贡献
- 使用创建新服务器
npm run create-server - 实施您的工具、资源和提示
- 为您的实现添加测试
- 提交拉取请求
许可证
麻省理工学院
