项目介绍
轻松获取美观的MCP安装指南以供您的文档或README使用
减少您MCP服务器的安装摩擦
MCP可以安装在数十个客户端上，并且通常需要用户运行命令或编辑某个位置的JSON配置文件，有时还需要重启客户端。当您构建一个MCP服务器时，为每个客户端提供这些说明是一项巨大的开销。这就是install-this-mcp发挥作用的地方。这个库和网站生成了适用于不同客户端的全面安装指南，针对MCP（模型上下文协议）服务器。查看最新演示
为了满足每个人的需求，您可以多种方式获取安装指南：
| 方法 | 示例 |
|---|---|
| 简单链接 | https://installthismcp.com/NAME?url=https://example.com/mcp |
| 嵌入式框架 | <iframe src="https://installthismcp.com/Parallel%20Task%20MCP?url=https%3A%2F%2Ftask-mcp.parallel.ai%2Fmcp&iframe=1" width="100%" height="600px"></iframe> |
| 结构化JSON | 以任何你喜欢的方式呈现安装方法。npm i install-this-mcp |
| Markdown按钮 |  |
| Markdown客户端列表 | - Cursor<br>- VS Code<br>- Claude Desktop / Claude.ai<br>- Claude Code<br>- Windsurf<br>- Cline<br>- Gemini CLI<br>- ChatGPT |
| 完整的Markdown指南 | 示例：https://github.com/jaw9c/awesome-remote-mcp-servers |
更新日志：
包的使用
const {
generateMCPConfig,
generateMCPInstallationGuide,
} = require("mcp-installation-guide");
// 获取配置对象
const configs = generateMCPConfig("https://api.example.com/mcp", "我的服务器");
// 获取markdown指南
const markdown = generateMCPInstallationGuide(
"https://api.example.com/mcp",
"我的服务器"
);
Worker的使用
Cloudflare Worker托管在installthismcp.com，提供以下功能：
- 首页：访问根URL以进入表单输入服务器详情
- 指南生成：访问
/{服务器名称}?url={mcpUrl}以生成样式化的HTML指南
示例
开发
- 安装依赖：
npm install - 本地测试：
wrangler dev - 发布：
wrangler publish
常见问题
这支持本地MCP吗？
不，目前这不在我们的范围内。installthismcp.com仅支持远程MCP。如果您想贡献并维护这部分，请联系我们。
这支持需要API密钥的MCP吗？
不，这也超出了范围，我们正在努力实现一个所有客户端都提供一键安装而无需复杂配置指令的世界。目前仅支持无认证的公共MCP或根据MCP协议规范支持OAuth的MCP。
能否添加XYZ语言模型客户端？
我们倾向于广泛采用的客户端，但欢迎不太流行的客户端，只要它们支持一键安装深度链接和OAuth。要添加客户端，请打开PR修改index.js。