agileconfig-mcp-server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@agileconfig-mcp-server list all applications"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
AgileConfig MCP Server
基于 AgileConfig 的 MCP (Model Context Protocol) 服务器。将 AgileConfig 配置中心的 全部 RESTful API 暴露为 MCP 工具,让你在 AI 工具中直接用自然语言管理配置中心。
目录
Related MCP server: volcengine-mcp-server
功能概览
本 MCP 服务器完整覆盖了 AgileConfig 的 9 大功能模块、36 个 MCP 工具,对应 AgileConfig 的全部 RESTful API:
模块 | 工具数 | 涵盖能力 |
📱 应用管理 | 5 | 创建、查看、编辑、删除应用 |
⚙️ 配置管理 | 11 | 配置增删改查、发布/下线、历史查看、版本回滚 |
🖥️ 节点管理 | 3 | 集群节点查看、添加、移除 |
👤 用户管理 | 7 | 用户 CRUD、登录、密码修改 |
🔐 权限管理 | 2 | 查看和设置用户的细粒度 RBAC 权限 |
📋 系统日志 | 1 | 按应用/类型/时间范围查询操作日志 |
🔌 客户端管理 | 2 | 查看已连接客户端、强制断开 |
🔍 服务发现 | 3 | 服务注册、查询、注销 |
⚙️ 系统设置 | 2 | 查看和更新系统级配置 |
核心特性
🚀 完整 API 覆盖 — 实现了 AgileConfig 所有 RESTful API,无遗漏
🌍 多环境支持 — 按
env参数隔离 DEV/PROD 等环境;不设env时操作所有环境🔐 双认证模式 — Admin Basic Auth(管理操作)和 App Secret Basic Auth(客户端拉取配置)
⚡ 配置实时生效 — 发布后 AgileConfig 通过 WebSocket 实时推送至所有客户端
📦 npx 零安装 — 发布到 npm 后,一行配置即可使用,无需克隆和编译
🛡️ 错误处理完善 — 所有 API 调用均包含超时控制、异常捕获和结构化错误返回
在 AI 工具中使用
前提条件:Node.js >= 18,且有一个运行中的 AgileConfig 服务端。
Claude Code
编辑 ~/.claude/settings.json(全局)或项目根目录的 .claude/settings.json(项目级):
{
"mcpServers": {
"agileconfig": {
"type": "stdio",
"command": "npx",
"args": ["-y", "agileconfig-mcp-server"],
"env": {
"AGILECONFIG_URL": "http://your-agileconfig-server:5000",
"AGILECONFIG_ADMIN_USERNAME": "admin",
"AGILECONFIG_ADMIN_PASSWORD": "your-password",
"AGILECONFIG_ENV": "DEV"
}
}
}
}重启 Claude Code 后,用自然语言操作配置中心:
"帮我看下 AgileConfig 上有哪些应用" "给 my-app 添加一个数据库连接字符串配置" "查看 my-app 的配置发布历史" "创建用户 tester,角色 NormalUser" "检查所有服务节点的在线状态" "把 my-app 的配置回滚到上一个版本"
Claude Desktop
编辑 ~/Library/Application Support/Claude/claude_desktop_config.json(macOS):
{
"mcpServers": {
"agileconfig": {
"command": "npx",
"args": ["-y", "agileconfig-mcp-server"],
"env": {
"AGILECONFIG_URL": "http://your-agileconfig-server:5000",
"AGILECONFIG_ADMIN_USERNAME": "admin",
"AGILECONFIG_ADMIN_PASSWORD": "your-password",
"AGILECONFIG_ENV": "DEV"
}
}
}
}VS Code / Cursor
在 VS Code 的 mcp.json 或 Cursor 的 .cursor/mcp.json 中配置:
{
"mcpServers": {
"agileconfig": {
"command": "npx",
"args": ["-y", "agileconfig-mcp-server"],
"env": {
"AGILECONFIG_URL": "http://your-agileconfig-server:5000",
"AGILECONFIG_ADMIN_USERNAME": "admin",
"AGILECONFIG_ADMIN_PASSWORD": "your-password",
"AGILECONFIG_ENV": "DEV"
}
}
}
}Windsurf
编辑 ~/.codeium/windsurf/mcp.json:
{
"mcpServers": {
"agileconfig": {
"command": "npx",
"args": ["-y", "agileconfig-mcp-server"],
"env": {
"AGILECONFIG_URL": "http://your-agileconfig-server:5000",
"AGILECONFIG_ADMIN_USERNAME": "admin",
"AGILECONFIG_ADMIN_PASSWORD": "your-password"
}
}
}
}Gemini CLI
gemini mcp add agileconfig -- npx -y agileconfig-mcp-server执行后 Gemini CLI 会使用当前 shell 的环境变量,请确保已设置:
export AGILECONFIG_URL=http://your-agileconfig-server:5000
export AGILECONFIG_ADMIN_USERNAME=admin
export AGILECONFIG_ADMIN_PASSWORD=your-passwordCodex CLI
codex mcp add agileconfig -- npx -y agileconfig-mcp-serverAI 工具配置速查表
AI 工具 | 配置文件位置 | 配置方式 |
Claude Code |
| JSON 配置 |
Claude Desktop |
| JSON 配置 |
VS Code |
| JSON 配置 |
Cursor |
| JSON 配置 |
Windsurf |
| JSON 配置 |
Gemini CLI | — |
|
Codex CLI | — |
|
本地使用
如果你不想等待 npm 发布,或者需要二次开发,可以在本地克隆并使用。
环境准备
Node.js: >= 18(推荐 20+)
npm: >= 9
AgileConfig 服务端: 需要有一个运行中的 AgileConfig 实例
克隆 & 安装
# 进入你的工作目录
cd /path/to/your/workspace
# 克隆项目
git clone <repo-url> agile-confg-mcp
cd agile-confg-mcp
# 安装依赖
npm install配置环境变量
# 从模板创建 .env
cp .env.example .env编辑 .env 文件,填入你的 AgileConfig 服务端信息:
# AgileConfig 服务端地址
AGILECONFIG_URL=http://localhost:5000
# Admin 认证(用户名固定为 admin)
AGILECONFIG_ADMIN_USERNAME=admin
AGILECONFIG_ADMIN_PASSWORD=123456
# 请求超时(毫秒)
AGILECONFIG_TIMEOUT=30000
# 默认环境。留空或设为 "" 将操作所有环境
AGILECONFIG_ENV=DEV编译 & 运行
# 编译 TypeScript → dist/
npm run build
# 直接启动服务器
npm start启动后 MCP 服务器会通过 stdio(标准输入输出)与 AI 工具通信,日志输出到 stderr:
[AgileConfig MCP Server] 已启动
[AgileConfig MCP Server] 目标地址: http://localhost:5000
[AgileConfig MCP Server] 默认环境: DEV使用 MCP Inspector 调试
MCP 官方提供了 Inspector 工具,可以直观地查看工具列表、测试工具调用、检查协议消息:
# 启动 Inspector(会自动打开浏览器)
npm run inspector浏览器打开后:
左侧 Tools 面板 — 查看所有注册的 36 个工具及其参数 schema
点击工具名 — 在右侧填入参数,点击 "Run" 测试调用
底部 Console — 查看 JSON-RPC 请求和响应的原始报文
如果只想验证服务器能否正常启动(不打开浏览器):
# 直接经 stdio 启动,发送一个 list_tools 请求验证
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' | node dist/index.js在 AI 工具中连接本地 MCP
使用本地路径代替 npx,在 AI 工具的 MCP 配置中指定为 node + 本地 dist/index.js 路径:
{
"mcpServers": {
"agileconfig": {
"type": "stdio",
"command": "node",
"args": ["/absolute/path/to/agile-confg-mcp/dist/index.js"],
"env": {
"AGILECONFIG_URL": "http://your-agileconfig-server:5000",
"AGILECONFIG_ADMIN_USERNAME": "admin",
"AGILECONFIG_ADMIN_PASSWORD": "your-password",
"AGILECONFIG_ENV": "DEV"
}
}
}
}对比:npx 方式适合最终用户,无需克隆代码;本地
node方式适合开发调试,修改代码后npm run build即可生效。
全部 MCP 工具列表
应用管理
工具名 | 说明 | API |
| 获取所有应用列表 |
|
| 根据 ID 获取单个应用详情 |
|
| 创建新应用(名称/分组/密钥/继承等) |
|
| 编辑应用信息 |
|
| 删除应用(不可逆) |
|
配置管理
工具名 | 说明 | 认证 | API |
| 获取已发布配置(供客户端拉取) | App Secret |
|
| 获取所有配置(含编辑中未发布项) | Admin |
|
| 获取单个配置项详情 | Admin |
|
| 添加新配置项(键值对) | Admin |
|
| 修改配置项的值/分组/描述 | Admin |
|
| 删除配置项(软删除) | Admin |
|
| 发布应用的全部待处理变更 | Admin |
|
| 上线单个配置项 | Admin |
|
| 下线单个配置项 | Admin |
|
| 查看应用的发布历史记录 | Admin |
|
| 回滚到指定历史版本 | Admin |
|
节点管理
工具名 | 说明 | API |
| 获取集群所有节点(含在线状态/心跳时间) |
|
| 添加节点到集群 |
|
| 从集群移除节点 |
|
用户管理
工具名 | 说明 | API |
| 获取所有用户列表 |
|
| 获取单个用户详情 |
|
| 创建用户(用户名/密码/角色/团队) |
|
| 编辑用户(含冻结/解冻) |
|
| 删除用户 |
|
| 修改指定用户的密码 |
|
| 用户登录,返回 JWT Token |
|
权限管理
工具名 | 说明 | API |
| 查看用户的所有权限 |
|
| 设置用户的 RBAC 权限 |
|
系统日志
工具名 | 说明 | API |
| 按应用/类型/时间范围查询操作日志 |
|
客户端管理
工具名 | 说明 | API |
| 查看已连接客户端(地址/心跳/标签) |
|
| 强制断开指定客户端 |
|
服务发现
工具名 | 说明 | API |
| 查看所有已注册服务及健康状态 |
|
| 注册服务(含元数据) |
|
| 注销服务 |
|
系统设置
工具名 | 说明 | API |
| 查看系统设置(CORS/JWT 等) |
|
| 更新系统设置 |
|
权限体系
AgileConfig 使用 RBAC(基于角色的访问控制),权限分为全局范围和应用范围:
权限 Key | 说明 |
| 添加应用 |
| 编辑应用 |
| 删除应用 |
| 应用授权管理 |
| 添加配置项 |
| 编辑配置项 |
| 删除配置项 |
| 发布配置 |
| 下线配置 |
| 添加节点 |
| 移除节点 |
| 断开客户端连接 |
| 创建用户 |
| 编辑用户 |
| 删除用户 |
权限范围:
GLOBAL— 全局权限,对所有资源生效APP_{appId}— 仅对指定应用生效(例如APP_my-app)
使用示例
示例 1:配置管理全流程
用户: 帮我在 AgileConfig 中为 my-app 添加数据库连接配置
AI 执行流程:
──查看现有配置
→ agileconfig_get_all_configs(appId="my-app")
──添加配置项
→ agileconfig_create_config(
appId="my-app",
key="ConnectionStrings:Default",
value="Server=prod-db;Database=main;User=sa",
description="生产数据库连接字符串",
env="DEV"
)
──发布到客户端
→ agileconfig_publish_config(appId="my-app", env="DEV")示例 2:运维排障
用户: 检查 AgileConfig 集群运行状态,看看有没有异常
AI 执行流程:
──检查节点健康
→ agileconfig_list_nodes()
──查看已连接客户端
→ agileconfig_list_clients()
──查看错误日志
→ agileconfig_get_syslogs(logType="Error", pageSize=20)
──汇总结果,告知用户节点/客户端/异常情况示例 3:新成员入职 — 创建账号并授权
用户: 新同事 zhangsan 入职了,给他创建 AgileConfig 账号,让他管理 my-app 的配置
AI 执行流程:
──创建用户
→ agileconfig_create_user(
userName="zhangsan",
password="temp@123456",
role="NormalUser"
)
──分配权限(仅限 my-app 的配置管理权限)
→ agileconfig_set_user_permissions(
userId="<返回的用户ID>",
permissions='[
{"functionKey":"CONFIG_ADD","appId":"my-app","enable":true},
{"functionKey":"CONFIG_EDIT","appId":"my-app","enable":true},
{"functionKey":"CONFIG_PUBLISH","appId":"my-app","enable":true}
]'
)示例 4:跨环境操作
用户: 把 DEV 环境的 my-app 配置复制到 PROD
AI 执行流程:
──读取 DEV 配置
→ agileconfig_get_published_configs(appId="my-app", appSecret="xxx", env="DEV")
──逐条在 PROD 创建
→ agileconfig_create_config(appId="my-app", key="...", value="...", env="PROD")
──发布 PROD 配置
→ agileconfig_publish_config(appId="my-app", env="PROD")环境变量参考
变量名 | 必填 | 说明 | 默认值 |
| 是 | AgileConfig 服务端地址 |
|
| 否 | Admin 用户名 |
|
| 否 | Admin 密码 |
|
| 否 | API 请求超时(毫秒) |
|
| 否 | 默认操作环境,留空 = 操作所有环境 |
|
项目结构
agile-confg-mcp/
├── src/
│ ├── index.ts # MCP 服务器主入口(工具注册 + 调用分发,~1100 行)
│ ├── agileconfig-client.ts # AgileConfig REST API 客户端(~450 行)
│ └── types.ts # 完整的 TypeScript 类型定义(~250 行)
├── dist/ # 编译产物(发布到 npm)
├── package.json # 含 bin 入口,支持 npx
├── tsconfig.json
├── .env.example # 环境变量模板
├── .gitignore
└── README.md发布到 npm
# 确保已登录 npm
npm login
# 发布(prepublishOnly 脚本会自动执行 npm run build 确保 dist/ 最新)
npm publish发布后,任何人都可以通过 npx 零安装使用:
npx -y agileconfig-mcp-server参考链接
AgileConfig 开源项目 — 基于 .NET Core 的轻量级分布式配置中心
AgileConfig RESTful API 介绍 — API 完整文档
MCP 协议规范 — Model Context Protocol 官方文档
MCP TypeScript SDK — TypeScript SDK 参考
MIT License
🤖 Generated with Claude Code
Available Tools
36 toolsagileconfig_add_nodeA
向 AgileConfig 集群添加一个新的服务节点。需要指定节点的访问地址。
Inputs: address (required), remark.
agileconfig_change_passwordA
修改指定用户的密码,需要提供旧密码和新密码。
Inputs: userId (required), newPassword (required), oldPassword (required).
agileconfig_create_appB
创建一个新的应用。需要指定应用名称,可选设置分组、密钥、是否启用、是否继承、继承应用列表和管理员。
Inputs: name (required), group, secret, enabled, +3 more.
agileconfig_create_configA
为指定应用添加一个新的配置项(键值对)。创建后需要发布才能对客户端生效。
Inputs: key (required), appId (required), value (required), env, +2 more.
agileconfig_create_userB
创建新用户。需要指定用户名和密码,可选设置团队归属和角色(SuperAdmin/Admin/NormalUser)。
Inputs: password (required), userName (required), role, team.
agileconfig_delete_appA
删除指定的应用。注意:此操作不可逆!
Inputs: id (required).
agileconfig_delete_configB
删除指定的配置项(软删除)。
Inputs: id (required), env.
agileconfig_delete_nodeB
从 AgileConfig 集群中移除指定的服务节点。
Inputs: address (required).
agileconfig_delete_userC
删除指定的用户。
Inputs: id (required).
agileconfig_disconnect_clientA
强制断开指定客户端的连接。被断开的客户端将自动尝试重连。
Inputs: clientId (required).
agileconfig_get_all_configsA
获取某个应用的所有配置(含未发布项,需 Admin 认证)。管理员可用此接口查看编辑中的配置。
Inputs: appId (required), env.
agileconfig_get_appB
根据应用 ID 获取单个应用的详细信息。
Inputs: id (required).
agileconfig_get_configB
根据配置 ID 获取单个配置项的详细信息,包括键、值、状态等。
Inputs: id (required), env.
agileconfig_get_published_configsA
获取某个应用的所有已发布配置(使用 App 认证方式,适合客户端拉取配置)。返回配置的键值对列表。
Inputs: appId (required), appSecret (required), env.
agileconfig_get_publish_historyA
获取某个应用的配置发布历史记录,包含每次发布的时间、版本和操作人。
Inputs: appId (required), env.
agileconfig_get_settingsA
获取 AgileConfig 的系统设置,包括 CORS 配置、JWT 密钥设置等。
Inputs: no named parameters.
agileconfig_get_syslogsA
查询系统操作日志。可按应用、日志类型(Normal/Warn/Error)、时间范围筛选,支持分页。
Inputs: appId, endTime, logType, pageSize, +2 more.
agileconfig_get_userB
根据用户 ID 获取单个用户的详细信息。
Inputs: id (required).
agileconfig_get_user_permissionsB
获取指定用户的权限列表,包括各功能模块的操作权限和应用级权限。
Inputs: userId (required).
agileconfig_list_appsA
获取 AgileConfig 中的所有应用列表。返回应用的 ID、名称、密钥、是否启用、分组等信息。
Inputs: no named parameters.
agileconfig_list_clientsA
获取当前连接到 AgileConfig 的所有客户端信息。可用于排查配置推送问题。
Inputs: no named parameters.
agileconfig_list_nodesA
获取 AgileConfig 集群中所有服务节点的信息,包括节点地址、在线状态、最后心跳时间等。
Inputs: no named parameters.
agileconfig_list_servicesA
获取所有已注册的服务信息,包括健康状态、IP、端口等。
Inputs: no named parameters.
agileconfig_list_usersA
获取系统中所有用户的列表,包括用户名、角色、状态、团队等信息。
Inputs: no named parameters.
agileconfig_offline_configB
下线单个配置项,使其对客户端暂不可见。
Inputs: id (required), env.
agileconfig_publish_configA
发布某个应用的所有待发布配置变更。发布后,所有连接到该应用的客户端将通过 WebSocket 实时收到更新通知。
Inputs: appId (required), env.
agileconfig_publish_single_configB
上线单个配置项,使其对客户端生效。
Inputs: id (required), env.
agileconfig_register_serviceA
在 AgileConfig 中注册一个新服务。用于服务发现场景,支持设置元数据。
Inputs: ip (required), port (required), serviceId (required), serviceName (required), +1 more.
agileconfig_rollback_configA
将应用配置回滚到指定的历史版本。需要提供发布历史 ID。此操作会撤销该版本之后的所有变更。
Inputs: historyId (required), env.
agileconfig_set_user_permissionsA
设置用户的权限。权限包含:APP_ADD、CONFIG_ADD/EDIT/DELETE/PUBLISH、NODE_ADD/DELETE、USER_ADD/EDIT/DELETE 等。每个权限可针对全局(appId="GLOBAL")或指定应用(appId="my-app")。
Inputs: userId (required), permissions (required).
agileconfig_unregister_serviceB
从 AgileConfig 注销一个已注册的服务。
Inputs: serviceId (required).
agileconfig_update_appB
编辑已有应用的信息,可修改名称、分组、密钥、启用状态、继承设置等。
Inputs: id (required), name, group, secret, +4 more.
agileconfig_update_configA
修改已有配置项的值、分组或描述。修改后需要重新发布才能对客户端生效。
Inputs: id (required), env, key, group, +2 more.
agileconfig_update_settingsB
更新 AgileConfig 的系统设置,可修改管理员密码、JWT 密钥、CORS 配置等。
Inputs: corsEnabled, corsOrigins, adminPassword, jwtTokenSecret.
agileconfig_update_userA
编辑已有用户的信息,可修改用户名、密码、角色、状态等。冻结用户可将其状态设为 Frozen。
Inputs: id (required), role, team, status, +2 more.
agileconfig_user_loginB
用户登录,成功后返回 JWT Token。
Inputs: password (required), userName (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 36 tools
Each tool has a clear and distinct purpose, with verbs and nouns that uniquely identify the operation and target resource. There is no overlap; for example, 'publish_config' vs 'publish_single_config' are differentiated by scope.
All tools follow a consistent 'agileconfig_verb_noun' pattern in snake_case, with verbs like create, delete, get, list, update, etc. The naming is predictable and uniform across the entire set.
With 36 tools, the count is high but justified by the broad scope of managing configurations, apps, users, nodes, services, and settings. However, it exceeds the ideal range (3-15) and falls into the heavy category, making it slightly bloated.
The tool set covers CRUD and lifecycle operations for all major entities (apps, configs, users, nodes, services, clients), plus publishing, rollback, permissions, and logs. Minor gaps like batch operations or group management exist, but core workflows are well-supported.
Related MCP Connectors
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
MCP server that lets your AI assistant build and deploy apps, hosting each one at a live URL.
MCP server for AI agents to plan, verify, and deploy Cloudflare-native apps.
Related MCP Servers
- AlicenseBqualityDmaintenanceAn MCP server that enables AI assistants to query and manage Nacos configurations. It supports Nacos 3.x for retrieving or publishing configuration files and includes an optional read-only mode for secure environments.23MIT
- AlicenseCqualityDmaintenanceMCP server that exposes Volcengine OpenAPI as tools, enabling AI agents to interact with Volcengine services like IAM.116 npm1MIT
- AlicenseNot gradedqualityCmaintenanceA config-driven MCP server that exposes OData and REST APIs as MCP tools, enabling AI assistants to query, manage, and monitor SAP backends through natural language.160 npm33MIT
- FlicenseNot gradedqualityCmaintenanceMulti-cloud MCP server that exposes cloud AI models as tools for AI CLI agents, supporting streaming, conversation history, parallel multi-model queries, and dynamic model discovery.2-