使用说明
mcpm-立即生成MCP服务器
磷酸二氢钙 是一个利用 MCP TypeScript SDK 快速构建和管理模型上下文协议(MCP)服务器项目。只需一个命令,您就可以创建一个功能齐全的MCP服务器,并立即将其连接到Claude Code或您自己的LLM应用程序。
特性
-
项目脚手架:
使用mcpm init创建一个新的、可投入生产的MCP服务器项目。 -
预配置的锅炉板:
生成一个准备运行的项目,包括一个带有资源和工具示例的示例MCP服务器。
安装
通过NPM
npm install -g @mcpkit/mcpm
快速开始
初始化新的MCP服务器项目:
mcpm init --name my-mcp-server
这将创建一个名为的新目录 my-mcp-server 使用基本的MCP服务器项目框架。
导航并安装依赖项:
cd my-mcp-server
npm install
构建并运行您的服务器:
npm run build
您的MCP服务器现在已准备好与Claude Code一起使用。
将您的MCP服务器连接到Claude Code
生成并启动MCP服务器后,您可以将其连接到Claude Code以测试其功能:
将您的MCP服务器连接到Claude Code
- 将您的MCP服务器添加到Claude Code:
# Basic syntax
$ claude mcp add <server-name> <command> [args...]
# Example: Adding your generated MCP server
$ claude mcp add my-mcp-server -- node dist/server.js
- 验证您的服务器是否已成功添加:
$ claude mcp list
- 选择您的MCP服务器并开始与Claude一起使用:
$ claude
> add the number 5 and the number 7
项目结构
运行后 mcpm init,您的项目将包括:
src/server.ts:带有示例命令的Starter MCP服务器文件(例如,添加工具和问候资源)。package.json:已为MCP SDK和TypeScript预配置。tsconfig.json:标准TypeScript配置。
用法
生成的MCP服务器包括以下示例:
- 工具:基本操作(如加法)的示例工具。
- 资源:提供动态内容,如问候语。
- 鼓励:预定义的模板,以方便LLM交互。
定制 src/server.ts 根据需要添加或修改工具、资源和提示。有关高级用法,请参阅 MCP TypeScript SDK文档.
高级配置
您还可以使用JSON配置添加MCP服务器:
$ claude mcp add-json my-mcp-server '{"type":"stdio","command":"node","args":["dist/server.js"],"env":{"DEBUG":"true"}}'
注: 在开发MCP服务器时,您可能需要在更改后重新启动它。您可以在Claude Code中更新服务器配置,而无需删除和重新添加。
贡献
欢迎投稿!贡献:
- 分叉存储库。
- 为您的功能或错误修复创建一个新分支。
- 编写测试并确保代码质量(建议使用ESLint/Pretier)。
- 提交一个拉取请求,明确描述您的更改。
许可证
该项目根据MIT许可证获得许可。
支持
如果您遇到任何问题或有疑问,请在 GitHub存储库.
