使用说明
🛠️ 创建MCP服务器
一个简单的CLI,可以在几秒钟内构建和启动MCP(模型上下文协议)服务器项目。
📚 目录
🚀 这是什么?
@create-mcp/server 是一个命令行工具,可以从模板生成完全配置的MCP服务器项目。它可以帮助您快速开始:
- ✅ 预定义的项目结构
- ✅ 即用型开发和生产脚本
- ✅ 一线服务器+巡检员上线
- ✅ 无需手动设置
📦 安装
您不需要全局安装它。只需运行:
npx @create-mcp/server
🧪 用法
运行CLI后,系统将询问您:
- 选择模板
- 输入项目名称
完成后,CLI将:
- 将所选模板复制到新文件夹中
- 安装依赖项
- 提供入门说明
📂 示例
npx @create-mcp/server
选择一个模板并提供您的项目名称:
? Select a template: mcp-server-default
? Project name: my-awesome-mcp
输出:
✅ Your MCP server project has been created successfully!
Next steps:
cd my-awesome-mcp → Navigate into your new project folder
Available scripts:
npm run inspector → Open the MCP Inspector in your browser (no client install needed)
npm run dev → Start the server locally for development
npm run build → Build your project for production
Happy coding! 🚀
📜 脚本
| 脚本 | 描述 |
|---|---|
npm run dev |
使用实时重新加载(开发模式)启动服务器 |
npm run build |
构建用于生产的服务器(输出到 /dist) |
npm run inspector |
在默认浏览器中启动MCP检查器 |
npm run deploy |
(可选)将包发布到npm(手动控制) |
🔍 使用MCP检查器
MCP Inspector是一个功能强大的开发工具,允许您:
- 查看实时请求和响应流量
- 无需安装外部客户端即可调试数据流
- 直观地探索端点、上下文和流
使用以下方式启动它:
npm run inspector
然后访问终端中显示的URL(通常 http://localhost:6274/...).
📘 完整文档请点击此处: 👉 如何使用MCP检查器
⚙️ 在VSCode或其他环境中使用
一旦您的MCP服务器CLI包发布到npm,您就可以使用以下命令调用它 npx。以下是如何在VSCode中设置它:
示例(用于 tasks.json 或外部跑步者):
"mcp-name": {
"command": "npx",
"args": ["-y", "mcpname@latest"]
}
✅ 这确保了:
- 你总是跑 最新版本
- 您跳过确认提示
- 您可以将其集成到任何工具或CI/CD工作流中
💡 提示:如果您经常使用别名,请在shell配置中添加别名:
alias mcpname="npx -y mcpname@latest"
📤 部署(可选)
要将包发布到npm:
npm login
npm run build
npm run deploy
ℹ️ 如果使用作用域包:
npm publish --access public
💡 你也可以离开
deploy脚本为空,允许每个开发人员定义他们首选的部署策略。
🙋♂️ 问题或贡献?
打开问题或拉取请求以建议模板或功能!
📄 许可证
MIT许可证
🌐 仓库
这个项目的源代码可以在GitHub上找到:
