文档数据库云管理平台(免费版)

通过API浏览和调用文档数据库云管理平台的管理接口.

输入格式

核心能力

1. API目录浏览

通过 atlas-api.mjs catalog 列出所有可用的API分类和端点，覆盖50+分类，包括集群管理、数据库用户、网络配置、备份恢复、监控告警等.

node （请参考skill目录中的脚本文件） catalog

2. 端点详情获取

通过 atlas-api.mjs detail 查看特定端点的详细信息，包括HTTP方法、路径参数、请求体Schema和响应格式.

node （请参考skill目录中的脚本文件） detail --category "Clusters" --endpoint "Create Cluster"
```- 验证返回数据的完整性和格式正确性
- 参考`端点详情获取`的配置文档进行参数调优
### 3. Schema定义查询
查看API端点的请求和响应Schema定义，了解参数类型、是否必填和默认值.
```bash
node （请参考skill目录中的脚本文件） detail --category "Database Users" --endpoint "Create Database User" --schema
```- 验证返回数据的完整性和格式正确性
- 参考`Schema定义查询`的配置文档进行参数调优
### 4. 实时API调用
通过 `atlas-call.mjs` 直接调用API端点，支持 `--dry-run` 预检和 `--yes` 自动确认.
```bash
# 预检模式（不实际执行）
node （请参考skill目录中的脚本文件） --category "Clusters" --endpoint "Create Cluster" --dry-run --data '{"name":"myCluster", "providerSettings": {"providerName": "AWS", "regionName": "US_EAST_1", "instanceSizeName": "M10"}}'
# ...
# 实际执行
node （请参考skill目录中的脚本文件） --category "Clusters" --endpoint "Create Cluster" --yes --data '{"name":"myCluster", "providerSettings": {"providerName": "AWS", "regionName": "US_EAST_1", "instanceSizeName": "M10"}}'

快速开始

1. 确认运行环境满足依赖说明中的要求
2. 在AI Agent对话中调用本技能,提供必要的输入参数
3. 检查输出结果,根据需要进行后续处理

详细的输入输出格式请参考下方章节说明。

适用场景

使用流程

1. 设置环境变量 ATLAS_CLIENT_ID 和 ATLAS_CLIENT_SECRET
2. 用 catalog 浏览API分类,或用 --search 搜索
3. 用 detail 查看端点详情和Schema
4. 用 --dry-run 预检请求
5. 确认后用 --yes 实际执行

示例

示例:创建集群（dry-run预检）

node （请参考skill目录中的脚本文件） \
  --category "Clusters" \
  --endpoint "Create Cluster" \
  --dry-run \
  --data '{
    "name": "prod-cluster",
    "clusterType": "REPLICASET",
    "providerSettings": {
      "providerName": "AWS",
      "regionName": "US_EAST_1",
      "instanceSizeName": "M10"
    },
    "replicationSpecs": [{
      "numShards": 1,
      "regionsConfig": {"US_EAST_1": {"electableNodes": 3, "priority": 7, "readOnlyNodes": 0}}
    }]
  }'

输出：

[dry-run] Request would be:
  POST /api/atlas/v2.0/groups/{groupId}/clusters
  Body: {"name": "prod-cluster", "clusterType": "REPLICASET", ...}
No changes applied. Remove --dry-run to execute.

错误处理

常见问题

Q1: 支持哪些API分类？

A: 覆盖50+分类，包括 Alerts、Atlas Search、Auditing、Backup、Clusters、Database Users、Network Peering、Private Endpoints、Monitoring、Logs 等。用 atlas-api.mjs catalog 查看完整列表.

Q2: --dry-run和--yes有什么区别？

A: --dry-run 只预检请求不实际执行，显示将要发送的HTTP方法和请求体。--yes 跳过交互确认直接执行。建议先用 --dry-run 预检再实际执行.

Q3: 如何配置API凭证？

A: 设置环境变量 ATLAS_CLIENT_ID 和 ATLAS_CLIENT_SECRET。这是公私钥认证方式，在云管理平台的API Keys页面创建.

已知限制

• 仅管理云平台配置，不执行数据库查询
• 需要预先配置 ATLAS_CLIENT_ID 和 ATLAS_CLIENT_SECRET
• API调用有速率限制，429时需等待重试

依赖说明

运行环境

• Agent平台: 支持SKILL.md的任意AI Agent（Claude Code / Cursor / Codex / Gemini CLI等）
• 操作系统: Windows / macOS / Linux

依赖项

API Key 配置

需要配置对应API Key，详见上文环境配置章节

可用性分类

• 分类: MD+EXEC（）

API Key配置方式:

export API_KEY=${API_KEY:?请设置环境变量}

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

升级提示

本免费版提供基础功能。升级到完整版 mongodb-atlas-admin 获取全部能力和高级特性.