Decodo后台MCP服务器
](https://badge.fury.io/js/decodo-back-office-mcp) 
模型上下文协议(MCP)服务器,提供与Decodeo的代理管理API的无缝集成,使AI代理能够管理代理基础设施、子用户、流量监控和端点配置。
特性
🔧 子用户管理
- 创建、读取、更新和删除子用户
- 跟踪单个子用户流量和使用情况
- 管理子用户权限和配额
🌐 代理端点管理
- 检索可用的代理端点
- 生成自定义端点配置
- 监控端点运行状况并分析目标
🛡️ IP白名单管理
- 在白名单中添加/删除IP地址
- 批量白名单操作
- 使用说明管理IP配置
📊 流量和使用分析
- 实时交通监控
- 历史使用数据检索
- 目标分析和报告
- 订阅和配额监控
安装
通过npx(最简单-无需安装)
npx -y decodo-back-office-mcp通过NPM全球安装
npm install -g decodo-back-office-mcp
decodo-mcp来源
git clone https://github.com/andrewlwn77/decodo-back-office-mcp.git
cd decodo-back-office-mcp
npm install
npm run build
npm start快速开始
1.获取Decodeo API密钥
- 登录您的 Decodo仪表板
- 导航到“API密钥”部分
- 生成新的API密钥
2.配置环境
创建一个 .env 项目目录中的文件:
DECODO_API_KEY=your_api_key_here
DECODO_BASE_URL=https://api.decodo.com/v2
LOG_LEVEL=info3.MCP配置
适用于克劳德桌面
选项A:使用npx(推荐-无需安装) 添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"decodo-back-office": {
"command": "npx",
"args": ["-y", "decodo-back-office-mcp"],
"env": {
"DECODO_API_KEY": "your_api_key_here"
}
}
}
}选项B:使用全局安装
{
"mcpServers": {
"decodo-back-office": {
"command": "decodo-mcp",
"env": {
"DECODO_API_KEY": "your_api_key_here"
}
}
}
}选项C:来源
{
"mcpServers": {
"decodo-back-office": {
"command": "node",
"args": ["/path/to/decodo-back-office-mcp/dist/index.js"],
"env": {
"DECODO_API_KEY": "your_api_key_here"
}
}
}
}对于Continue.dev
使用npx(推荐): 添加到您的 config.json:
{
"experimental": {
"modelContextProtocol": true
},
"mcpServers": {
"decodo-back-office": {
"transport": {
"type": "stdio"
},
"command": "npx",
"args": ["-y", "decodo-back-office-mcp"],
"env": {
"DECODO_API_KEY": "your_api_key_here"
}
}
}
}对于Cline(VS代码)
使用npx(推荐): 添加到MCP设置中:
{
"mcpServers": {
"decodo-back-office": {
"command": "npx",
"args": ["-y", "decodo-back-office-mcp"],
"env": {
"DECODO_API_KEY": "your_api_key_here"
}
}
}
}手动启动服务器
# Using npx (easiest)
npx -y decodo-back-office-mcp
# Using global install
npm install -g decodo-back-office-mcp
decodo-mcp
# Development (from source)
npm run dev
# Production (from source)
npm run build
npm start配置
环境变量
| 变量 | 必填 | 默认 | 描述 |
|---|---|---|---|
DECODO_API_KEY | ✅ 是 | - | 您的Decodeo API密钥 |
DECODO_BASE_URL | 没有 | https://api.decodo.com/v2 | 解码API基础URL |
LOG_LEVEL | 没有 | info | 日志记录级别(错误、警告、信息、调试) |
MCP_SERVER_NAME | 没有 | decodo-back-office-mcp | 服务器标识 |
MCP_SERVER_VERSION | 没有 | 1.0.0 | 服务器版本 |
查找配置路径
Claude桌面配置位置
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 视窗:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
Continue.dev配置位置
- 所有平台:
~/.continue/config.json
可用工具
服务器提供14个MCP工具,用于完整的Decodo代理管理:
🔧 子用户管理(6个工具)
| 工具 | 说明 | 参数 |
|---|---|---|
decodo_create_sub_user | 创建新的子用户 | username, password?, email?, traffic_limit? |
decodo_get_sub_users | 列出所有子用户 | 无 |
decodo_get_sub_user | 获取特定子用户详细信息 | id |
decodo_update_sub_user | 更新现有子用户 | id, username?, password?, email?, traffic_limit? |
decodo_delete_sub_user | 删除子用户 | id |
decodo_get_sub_user_traffic | 获取子用户流量统计数据 | id, start_date?, end_date? |
🌐 代理管理(3个工具)
| 工具 | 说明 | 参数 |
|---|---|---|
decodo_get_endpoints | 检索代理端点 | 无 |
decodo_generate_endpoint | 生成自定义端点 | protocol?, format?, custom_params? |
decodo_get_target_info | 分析目标URL | url |
🛡️ IP白名单(3个工具)
| 工具 | 说明 | 参数 |
|---|---|---|
decodo_get_whitelist | 列出白名单IP | 无 |
decodo_add_whitelist_ip | 将IP添加到白名单 | ip, description? |
decodo_remove_whitelist_ip | 从白名单中删除IP | ip |
📊 分析(2个工具)
| 工具 | 说明 | 参数 |
|---|---|---|
decodo_get_traffic | 获取流量统计数据 | start_date?, end_date?, sub_user_id? |
decodo_get_subscriptions | 查看订阅信息 | 无 |
示例用法
与Claude Desktop一起使用
配置后,您可以询问Claude:
"Can you show me all my Decodo sub-users and their traffic usage?"
"Please create a new sub-user called 'test-user' with a 1GB traffic limit"
"Add IP address 192.168.1.100 to my whitelist for my home office"
"Generate a custom HTTPS endpoint for JSON responses"与API一起使用
// The server will automatically handle tool calls through MCP protocol
// Your AI client will have access to all 14 Decodo management tools故障排除
常见问题
服务器无法启动:
- 检查一下
DECODO_API_KEY在您的环境中设置 - 验证Node.js版本是否为18+(
node --version) - 跑
npm run build确保汇编
API错误:
- 验证您的Decodeo API密钥是否有效
- 检查您的Decodo帐户是否具有必要的权限
- 确保
DECODO_BASE_URL设置为https://api.decodo.com/v2
MCP客户端无法连接:
- 确保MCP配置中的服务器路径正确
- 检查服务器进程是否正在运行
- 验证环境变量是否正确传递
调试模式
启用调试日志记录:
LOG_LEVEL=debug npm start安全与最佳实践
- ✅ API密钥得到安全处理,从不记录
- ✅ 所有请求都包含正确的身份验证标头
- ✅ 使用Zod模式进行输入验证
- ✅ 使用经过净化的日志进行全面的错误处理
- ✅ TypeScript用于编译时类型安全
- ✅
.gitignore防止凭证泄漏
发展
建筑
npm run build测试
npm test
npm run test:coverage掉毛
npm run lint
npm run lint:fix类型检查
npm run typecheckapi参考
有关Decodeo API的详细文档,请访问: 解码API文档
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 添加新功能的测试
- 确保所有测试通过
- 提交拉取请求
支持
______________________________________________________________________
*采用BMAD Agent Team方法构建,用于全面的多视角开发。*
