使用说明
我的MCP服务器安装程序
将此项目用作模板
要基于此模板创建自己的MCP服务器安装程序,请执行以下操作:
- 克隆此存储库:
git clone https://github.com/yourorg/mcp-server-installer-template.git cd mcp-server-installer-template - 编辑
src/install.ts:- 更新
SERVER_CONFIG对象位于顶部,带有服务器的名称和端点。 - (可选)更新
CLI_NAME常量以匹配所需的CLI命令。pg-mcp-server-installer是通用名称,通常很好。
- 更新
- 编辑
package.json:- 更改
"bin"字段转换为所需的CLI命令名(应匹配CLI_NAME在……里面src/install.ts). - 更新
"name"以及所需的其他元数据。
- 更改
- 构建项目:
npm run build - 本地测试:
npm link your-cli-name install - 发布到npm(可选):
npm publish
现在,您的MCP服务器的安装程序已经准备就绪!
改进什么
| 更改内容 | 更改位置 | 示例 |
|---|---|---|
| 服务器名称/端点 | src/install.ts |
SERVER_CONFIG 对象 |
| CLI命令名称 | package.json (bin) |
"my-mcp-server-installer" |
| 包元数据 | package.json |
"name", "author"等等。 |
此项目提供了一个CLI安装程序,用于配置Claude Desktop以使用具有承载令牌身份验证的自定义MCP服务器。
运作原理
package.json定义CLI命令名(通过bin字段)并指向编译的JavaScript入口点(例如。,dist/install.js).src/install.ts包含安装程序逻辑和服务器特定的配置常量(如服务器名称和端点)。- CLI命令(例如。,
my-mcp-server-installer)已设置package.json并在帮助消息中引用install.ts. - 服务器特定的值(如Claude配置条目名称和端点)在中设置为常量
install.ts.
设置
-
编辑
src/install.ts- 在文件顶部设置服务器名称和端点:
const SERVER_NAME = 'Your Server Name'; const ENDPOINT = 'https://your-endpoint.example.com/sse';
- 在文件顶部设置服务器名称和端点:
-
编辑
package.json- 在中设置CLI命令名
bin字段:"bin": { "my-mcp-server-installer": "./dist/install.js" } - 这使得CLI可用作
npx my-mcp-server-installer发布或链接后。
- 在中设置CLI命令名
-
构建安装程序
npm run build # or npx tsc
用法
地方发展
- 直接使用ts节点运行安装程序:
npx ts-node src/install.ts install - 或者,构建并运行编译后的JS:
npm run build node dist/install.js install
CLI使用(发布或链接后)
- 全局安装以进行本地测试:
npm link my-mcp-server-installer install - 或者使用npx(发布到npm后):
npx my-mcp-server-installer install
安装程序做什么
- 提示输入不记名代币。
- 在您的Claude Desktop配置中添加或更新条目(例如。,
claude_desktop_config.json)使用指定的服务器名称和端点。 - 配置条目看起来像:
"Your Server Name": { "command": "npx", "args": [ "mcp-remote", "https://your-endpoint.example.com/sse", "--header", "Authorization: Bearer <YOUR_TOKEN>" ], "env": {} }
定制
- 要为其他服务器创建新的安装程序,只需更新顶部的常量
src/install.ts以及中的CLI名称package.json如果需要的话。
备注
- CLI命令名在中设置
package.json为了保持一致性,应该在代码的帮助消息中引用。 - 只需在中设置服务器特定值
src/install.ts.
有关更多详细信息,请参阅中的评论 src/install.ts 和 package.json.
快速开始
# Install the MCP server
npx my-mcp-server-installer install
# Check installation status
npx my-mcp-server-installer status
# Uninstall the MCP server
npx my-mcp-server-installer uninstall
它做什么
此安装程序:
- 提示您的持票人代币
- 自动查找您的Claude Desktop配置文件
- 添加带有令牌身份验证的MCP服务器配置
- 适用于macOS、Windows和Linux
配置位置
安装程序会自动找到您的Claude Desktop配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 视窗:
%APPDATA%/Claude/claude_desktop_config.json - Linux:
~/.config/claude/claude_desktop_config.json
项目结构
├── src/
│ └── install.ts # Main installer logic (TypeScript)
├── dist/ # Compiled JavaScript (generated)
├── package.json # Package configuration
├── tsconfig.json # TypeScript configuration
└── README.md # This file
安全说明
- 令牌存储在本地Claude Desktop配置文件中
- 配置文件只能由您的用户帐户读取
- 没有令牌被传输或存储在其他地方
需求
- Node.js 18或更高版本
- 已安装Claude Desktop
- MCP服务器的有效承载令牌
发展
# Install dependencies
npm install
# Build TypeScript
npm run build
# Test locally
node dist/install.js install
许可证
麻省理工学院
