README
🚀 Kong Konnect MCP 服务器
Kong Konnect 是一个功能强大的 API 与微服务管理平台。借助 MCP(管理控制平面)协议,用户能轻松与 Kong Konnect 交互并执行各类操作。本文档将为您详细介绍如何使用 Kong Konnect MCP 服务器。
🚀 快速开始
要使用 Kong Konnect MCP 服务器,您需要先进行安装与配置,之后就可以使用服务器执行各种操作。
✨ 主要特性
- 便捷的 API 与微服务管理:通过 MCP 协议,可轻松与 Kong Konnect 交互,执行各类管理操作。
- 丰富的命令支持:支持列出控制平面、获取控制平面信息、创建控制平面组等基本命令,还有分析 API 流量、管理消费者等高级功能。
- 可集成 Claude:能够与 Claude Desktop 集成,扩展使用场景。
📦 安装指南
安装 MCP 服务器
按以下步骤安装 Kong Konnect MCP 服务器:
-
克隆 Kong Konnect 代码仓库:
git clone https://github.com/kong/konnect.git cd konnect -
安装依赖项并构建项目:
make build -
启动 MCP 服务器:
./bin/konnect-mcp serve --config config.yaml
配置 MCP 服务器
在 config.yaml 文件中,可配置以下参数:
- API Key:您的 Kong Konnect API 访问密钥。
- Region:您使用的 Kong Konnect 区域(例如:
us,eu)。 - Endpoints:Kong Konnect 的 API 端点 URL。
示例配置:
api_key: your_api_key_here
region: us
endpoints:
- https://api.konghq.com/v1
💻 使用示例
基础用法
以下是 MCP 服务器支持的一些基本命令:
-
列出所有控制平面:
konnect-mcp list-control-planes -
获取特定控制平面信息:
konnect-mcp get-control-plane <control_plane_id> -
创建新的控制平面组:
konnect-mcp create-group --name my_new_group
高级用法
分析 API 流量
可使用 MCP 服务器分析特定服务的流量情况。例如:
-
列出所有服务:
konnect-mcp list-services <control_plane_id> -
查询特定时间段内的请求日志:
konnect-mcp get-requests --service-id <service_id> --start-time "2023-10-01T00:00:00Z" --end-time "2023-10-02T23:59:59Z"
管理消费者
通过 MCP 服务器管理消费者的权限和策略。例如:
-
列出所有消费者:
konnect-mcp list-consumers <control_plane_id> -
更新消费者的 API 访问权限:
konnect-mcp update-consumer <consumer_id> --add-permission "/my_api/*"
📚 详细文档
与 Claude 集成
安装 Claude Desktop
-
下载并安装 Claude Desktop。
-
打开配置文件:
- MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- MacOS:
-
添加 Kong Konnect MCP 服务器的配置:
{ "mcpServers": { "kong-konnect": { "command": "node", "args": [ "/absolute/path/to/mcp-konnect/build/index.js" ], "env": { "KONNECT_ACCESS_TOKEN": "your_api_key_here", "KONNECT_REGION": "us" } } } } -
重启 Claude Desktop 以应用配置。
常见问题
如何获取 API Key?
请访问 Kong Konnect 控制台,前往 Settings > API Keys 部分生成新的 API Key。
如何解决连接问题?
确保您的 Kong Konnect 实例运行正常,并且网络连接没有被阻止。您也可以检查日志文件以获取更多信息:
journalctl -u konnect-mcp.service --since "10 minutes ago"
示例代码
创建自定义插件
以下是一个简单的 Node.js 插件示例:
const { MCPClient } = require('kong-konnect');
async function main() {
const client = new MCPClient({
apiKey: 'your_api_key_here',
region: 'us'
});
// 获取所有控制平面组
const groups = await client.listGroups();
console.log(groups);
}
main().catch(console.error);
🔚 结束语
通过本文档,您应该能够顺利地使用 Kong Konnect MCP 服务器并完成各种操作。如果需要更多帮助,请参考 Kong Konnect 文档 或联系支持团队。
微信扫一扫