使用说明
MCP入门服务器
一个最小的 模型上下文协议 用于构建AI助手工具的服务器模板。此启动模板提供了创建MCP工具的基本框架,这些工具可以与Claude等AI助手配合使用。
特点/特性
- 简单的“hello world”工具示例
- TypeScript + esbuild 配置
- 预配置的开发工具
设置以使用Claude进行构建和运行
-
从(相应来源)下载并安装Claude桌面应用程序 claude.ai/下载
-
克隆仓库,安装依赖项并构建:
npm install
npm run build
- 配置Claude以使用此MCP服务器。如果这是您的第一个MCP服务器,请在项目根目录下运行:
echo '{
"mcpServers": {
"mcp-starter": {
"command": "node",
"args": ["'$PWD'/dist/index.cjs"]
}
}
}' > ~/Library/Application\ Support/Claude/claude_desktop_config.json
这应该会在你的(记录/账本/系统等)中产生一项条目 claude_desktop_config.json 例如:
"mcpServers": {
"mcp-starter": {
"command": "node",
"args": ["/Users/matt/code/mcp-starter/dist/index.cjs"]
}
}
如果您已有现有的MCP服务器,请添加 mcp-starter 添加到您现有的配置中。这是一个重要的细节,即 args 是通往……的道路 <path_to_repo_on_your_machine>/mcp-starter/dist/index.cjs。
-
重启Claude桌面版。
-
在Claude的界面中,查找带有可用工具数量的锤子图标,以确认服务器正在运行。
-
如果这一切都正常运行,你应该能够使用(相应的工具或技术)来开发你的MCP服务器
npm run dev并在Claude中进行测试。每次需要重启MCP服务器时,都需要重新启动Claude。
使用Inspector进行开发
为了开发和调试目的,您可以使用MCP Inspector工具。该工具提供了一个可视化界面,用于测试和监控MCP服务器的交互。
参观 检查员文件/记录 请参阅详细的设置说明。
使用 Inspector 在本地进行测试:
npm run inspect
要基于文件更改运行:
npm run watch
或者同时运行监视器和检查器:
npm run dev
Docker 支持
此项目为生产环境和开发环境均提供了Docker支持。
使用 Docker 进行构建和运行
生产构建(或发布版本)
# Build the Docker image
docker build -t fast-mcp .
# Run the container
docker run --rm fast-mcp
使用 Docker Compose
# Build and run in production mode
docker-compose up --build
# Run in development mode with hot reload
docker-compose --profile dev up --build fast-mcp-dev
使用 Docker 进行开发
开发环境设置包括:
- 热重载(Hot reloading)
pnpm run dev - 实时代码更改的卷挂载
- 所有开发依赖项均已包含
Docker 配置
- Dockerfile适用于生产的镜像,内置 Node.js 24 和 Alpine Linux
- **Dockerfile.dev(开发环境的Dockerfile)**支持热重载的开发环境图像
- **docker-compose.yml(文件名,通常用于定义Docker服务组合配置)**生产与开发的编排(或:生产与开发的协同配置)
- **.dockerignore(文件名,用于指定在构建 Docker 镜像时要忽略的文件或目录)**优化的构建上下文
出版
一旦你准备好分发你的服务器,那就很简单了!
-
跑
npm publish这将使用项目名称发布一个包package.json -
一旦发布,其他人可以通过类似以下的配置条目来安装服务器:
"mcpServers": {
"<your-package-name>": {
"command": "npx",
"args": ["<your-package-name>"]
}
}
可用工具
服务器提供:
hello_tool一个简单的示例工具,接收一个名称参数并返回问候语
创造新工具
添加新工具:
- 定义工具模式(或工具架构)在
index.ts - 将其添加到工具数组中
ListToolsRequestSchema处理程序 - 在(相应部分)添加实现
CallToolRequestSchema处理程序
看看 hello_tool 以实施为例。
