article
README
🚀 mcp-get
mcp-get 是一款强大的命令行工具,专门用于管理模型上下文协议(MCP)服务器。借助它,用户能够轻松地对各种 MCP 服务进行安装、配置和运行操作,极大提升了 MCP 服务管理的便捷性。
✨ 主要特性
- 多环境支持:支持多种运行时环境,包括 Node.js、Python 和 Go,满足不同开发者的使用需求。
- 详细配置:提供详细的环境变量配置,方便用户根据实际情况进行个性化设置。
- 丰富资源:精选注册表中包含大量经过验证的 MCP 服务器,为用户提供了多样化的选择。
- 社区驱动:支持社区贡献和扩展,促进项目的不断发展和完善。
📦 安装指南
安装示例
npx @michaellatman/mcp-get@latest install --name your-package-name
先决条件
- Node.js(版本14或更高)
- Python 3.6+
- Go 1.15+
💻 使用示例
基础用法
- 安装MCP服务器:
npx @michaellatman/mcp-get@latest install
- 启动服务:
npx @michaellatman/mcp-get@latest start
📚 详细文档
贡献指南
欢迎贡献代码!请参考贡献者文档了解如何参与。
联系方式
- 邮件:contact@your-domain.com
- GitHub:你的GitHub链接
添加自定义MCP服务器到注册表
无论您选择哪种方式,都必须遵循MCP协议规范。
选项1:独立包管理
-
创建您的MCP服务器:
- 根据MCP协议规格开发您的服务器。
- 通过npm或uvx发布为可安装包。
-
将包添加到注册表文件夹:在
packages/目录中添加您的服务器作为JSON文件:- 对于常规包,使用
packages/your-package-name.json - 对于范围包,使用
packages/scope--package-name.json(双短划线分隔范围和名称)
{ "name": "your-package-name", "description": "简要描述您的MCP服务器", "vendor": "您或您的组织的名称", "sourceUrl": "源代码仓库URL", "homepage": "主页或文档URL", "license": "许可证类型(例如,MIT)", "runtime": "node | python | go", "environmentVariables": { "SOME_API_KEY": { "description": "此密钥用途的描述", "required": true } } }注意:
name字段必须是npm或pip上可解析的包名称。runtime字段指定您的包应如何安装:- 使用
"runtime": "node"表示应通过npm安装的包。 - 使用
"runtime": "python"表示应通过uvx安装的包。
- 使用
- 始终包含一个
environmentVariables对象(如果没有则为{})。
- 对于常规包,使用
-
验证您的包:运行PR检查以验证您的包:
npm run pr-check
- 提交拉取请求:叉此仓库,添加您的包文件并提交PR。
选项2:社区服务器仓库
如果不想管理包部署和分发:
- 叉社区仓库:
- 添加您的服务器:
- 将实现添加到
src/目录 - 遵循现有模式和结构
- 包括必要的文档和测试
- 将实现添加到
- 提交拉取请求:
- 提交您的PR到社区服务器仓库
- 合并后,您的服务器将自动添加到注册表
许可证
本项目遵循MIT许可证。更多信息请访问许可证文件。
扫码联系在线客服