MCP安装指南生成工具

为MCP服务器生成跨客户端的安装指南,减少用户安装配置的复杂性。

  • by janwilmake
  • TypeScript
  • 本地部署
  • 24 星标
  • 更新于
在 GitHub 查看 janwilmake/install-this-mcp

使用说明

为您的文档或自述文件获取精美的MCP安装指南的最简单方法

减少MCP服务器的安装摩擦

MCP可以安装在数十个客户端中,通常需要用户在某处运行命令或编辑JSON配置文件,有时还需要重新启动客户端。当您构建MCP服务器时,必须为每个客户端向用户提供这些指令,这是一项巨大的开销。这就是安装此mcp的地方。此库和网站为不同客户端的mcp(模型上下文协议)服务器生成全面的安装指南。 在此处查看最新演示

为了满足每个人的需求,您可以通过多种方式获取安装指南:

方法 示例
简单链接 https://installthismcp.com/NAME?url=https://example.com/mcp
Iframe嵌入 <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客户端列表 - 光标
- VS Code
- 克劳德桌面/Claude.ai
- 克劳德代码
- 帆板运动
- 克莱恩
- Gemini CLI
- ChatGPT
完整Markdown指南 示例:https://github.com/jaw9c/awesome-remote-mcp-servers

变更日志:

包装使用

const {
  generateMCPConfig,
  generateMCPInstallationGuide,
} = require("mcp-installation-guide");

// Get configuration objects
const configs = generateMCPConfig("https://api.example.com/mcp", "My Server");

// Get markdown guide
const markdown = generateMCPInstallationGuide(
  "https://api.example.com/mcp",
  "My Server"
);

工人使用情况

Cloudflare Worker托管在 installthismcp.com 并提供:

  1. 着陆页:访问根URL以访问用于输入服务器详细信息的表单
  2. 指南生成:参观 /{serverName}?url={mcpUrl} 生成样式化的HTML指南

例子

  • 登录页面:https://installthismcp.com
  • 直接指导:https://installthismcp.com/Weather%20Server?url=https://api.example.com/mcp

发展

  1. 安装依赖项: npm install
  2. 本地测试: wrangler dev
  3. 部署: wrangler publish

常见问题解答

这支持本地MCP吗?

不,这目前超出了我们的范围。installthismcp.com仅支持远程MCP。但是,如果你想贡献和维护这一部分,请联系我们。

这是否支持需要API密钥的MCP?

不,这也超出了范围,我们正在努力实现一个世界,在这个世界里,每个客户都可以提供一键安装,而无需复杂的配置说明。目前只有公共MCP(没有身份验证)或具有OAuth的MCP(根据 MCP协议规范)支持。

你能添加LLM客户端XYZ吗?

我们青睐广泛采用的客户,但如果不太受欢迎的客户只需点击一下即可安装deeplink支持和oauth支持,我们也欢迎他们。要添加客户,请打开PR更改 index.js.

TODO

  • 对跨浏览器打开一键安装的iframe进行更多测试,并可能实现自动化并与供应商联系
  • 支持官方注册条目
  • 将其与发布的服务器卡规格对齐https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1649