使用说明
项目简介
DoiT MCP 服务器是一个实现了 Model Context Protocol (MCP) 的后端应用。它使大型语言模型 (LLM) 客户端(如 Claude, Cursor 等)能够通过标准化的 JSON-RPC 接口,安全便捷地访问 DoiT 云计算管理平台的 API,获取如云资源消耗、故障事件、报告等信息,并执行相关查询操作。
主要功能点
- 获取云平台事件和故障信息: 查询和检索各种云服务提供商(AWS, GCP 等)的已知故障和事件详情。
- 查询和分析云资源消耗异常: 列出并获取在您的云账户中检测到的成本或使用异常详情。
- 列出并运行定制的云分析报告: 查看您可访问的云分析报告列表,并根据配置运行特定查询获取结果。
- 获取云分析报告所需的维度信息: 提供可用于报告查询的维度列表及其类型,帮助构建有效的查询请求。
- 验证当前用户身份: 验证用于连接 DoiT API 的凭证是否有效,并返回关联的用户信息。
安装步骤
运行此服务器需要 Node.js v18 或更高版本以及一个有效的 DoiT API Key。
-
获取 DoiT API Key: 访问 DoiT 平台您的个人资料中的 API Key 部分获取。
-
安装 MCP 服务器: 最简单的方式是使用 Smithery CLI 进行安装和配置,或者您也可以直接使用 npx 运行。
- 使用 Smithery (推荐): 按照 Smithery 客户端的说明进行安装,例如:'npx -y @smithery/cli@latest install @doitintl/doit-mcp-server --client [您的LLM客户端名称]'
- 直接使用 npx: 大多数支持 MCP 的客户端可以通过配置直接调用 npx 命令来启动服务器。
服务器配置(面向LLM客户端)
您的LLM客户端需要配置如何启动此MCP服务器。标准的MCP客户端配置通常需要以下信息:
- 服务器名称 (server name): 例如 'doit_mcp_server' 或 'DoiT',用于在客户端内部识别此服务器。
- 启动命令 (command): 通常是 'npx'。
- 命令参数 (args): 通常是 '["-y", "@doitintl/doit-mcp-server@latest"]',指示 npx 运行最新版本的 '@doitintl/doit-mcp-server' 包。
- 环境变量 (env): 必须配置 'DOIT_API_KEY',值为您的 DoiT API Key。可选配置 'CUSTOMER_CONTEXT',值为特定的客户上下文标识符(如果需要)。这些环境变量需要由LLM客户端在启动服务器进程时提供。
具体配置格式请参考您的LLM客户端(如 Claude Desktop, Cursor 等)的官方文档中关于 MCP 服务器配置的部分。
基本使用方法
配置并启动服务器后,通过您的LLM客户端向大型语言模型提出与DoiT平台数据相关的自然语言问题或指令。LLM客户端将根据您的请求调用此MCP服务器提供的相应工具来获取信息。
示例:
- 询问最近的云平台故障:'What are the recent cloud incidents?' (最近有什么云故障?)
- 查询成本异常:'Show me the recent anomalies in my cloud costs.' (展示我最近的云成本异常。)
- 列出可用报告:'List all my available reports.' (列出我所有的报告。)
- 运行特定查询:'Run a query to show my top AWS services by cost for the last month.' (运行一个查询,展示我上个月按成本计算排名前的 AWS 服务。)
大型语言模型会通过MCP服务器与DoiT API交互,并将结果返回给您。
信息
分类
商业系统