README
🚀 DoiT MCP 服务器
DoiT MCP 服务器为访问 DoiT 平台数据提供了接口,能让像 Claude 这样的大语言模型获取故障排除和分析所需的 DoiT 平台数据,助力高效处理平台相关事务。
🚀 快速开始
使用 DoiT MCP 服务器前,需要满足一定的需求并进行安装配置,下面为你详细介绍。
✨ 主要特性
- 为大语言模型(如 Claude)提供访问 DoiT 平台数据的接口。
- 支持多种工具,可实现获取云事故、列出报告、生成报告以及验证用户等功能。
- 能够解析自然语言查询,方便用户获取所需信息。
📦 安装指南
需求
- Node.js v18 或更高版本
- 具备适当权限的 DoiT API 密钥
- 客户上下文标识符(用于特定客户的数据显示)
获取 DoiT API 密钥
要获取您的 DoiT API 密钥,请访问 API 密钥部分 您的 DoiT 个人资料。
安装方式
有多种方式可以安装和配置 MCP 服务器:
通过 Smithery 安装(推荐)
要为 Claude Desktop 自动安装 doit-mcp-server:
npx -y @smithery/cli@latest install @doitintl/doit-mcp-server --client claude
Claude Desktop 应用
要手动配置用于 Claude Desktop 应用的 MCP 服务器,请在 claude_desktop_config.json 文件中添加以下内容或通过“设置”部分进行配置(如此处所述):
{
"mcpServers": {
"doit_mcp_server": {
"command": "npx",
"args": ["-y", "@doitintl/doit-mcp-server@latest"],
"env": {
"DOIT_API_KEY": "your_api_key_here",
"CUSTOMER_CONTEXT": "optional_customer_context_here"
}
}
}
}
其他方法
您也可以通过以下方式安装 MCP 服务器:
- 克隆仓库:
git clone https://github.com/doitintl/doit-mcp-server.git
cd doit-mcp-server
- 安装依赖项:
npm install
- 启动服务器:
node index.js
💻 使用示例
基础用法
以下是一些常见查询的示例:
成本分析与节省
- "What are my Flexsave savings?"(我的Flexsave节省是多少?)- 这将分析您在云账户中的 Flexsave 成本优化节省。
- "What are my top 3 AWS services by cost?"(按成本排序,我有哪些前三名的AWS服务?)- 这将运行 Cloud Analytics 查询以识别您最高支出的 AWS 服务。
报告和分析
- "List all my available reports"(列出我所有可用的报告)- 这将显示您拥有的所有 Cloud Analytics 报告。
- "Show me the results of my 'Monthly Cost Overview' report"(向我展示我的“月度成本概览”报告的结果)- 这将获取并显示特定报告的结果。
异常检测
- "What are my recent GCP anomalies?"(我的最近的 Google Cloud Platform 异常是什么?)- 这将显示您 Google 云平台账户中最近的成本或使用异常。
- "Show me details about anomaly ABC123"(向我展示异常 ABC123 的详细信息)- 这将提供特定异常的详细信息。
这些示例展示了基本的使用模式。您可以根据需要组合和修改这些查询。MCP 服务器将解析您的自然语言查询,并使用适当的工具来获取所需信息。
工具说明
以下是 DoiT MCP 服务器支持的工具及其功能:
| 工具名称 | 功能 |
| ---- | ---- |
| get_cloud_incidents | 获取最近的云事故 |
| list_reports | 列出所有可用报告 |
| generate_report | 根据指定参数生成报告 |
| validate_user | 验证当前用户并返回其领域和电子邮件信息 |
🔧 技术细节
环境变量
DOIT_API_KEY:您的 DoiT API 密钥(必需)CUSTOMER_CONTEXT:您的客户上下文标识符(可选)
📄 许可证
本项目采用 MIT 许可证,详情请见 MIT 许可证。
扫码联系在线客服