Documentation Index
Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt
Use this file to discover all available pages before exploring further.
工具参考
CloudX MCP 当前公开六个工具：五个报表工具与一个文档检索工具。
工具汇总
| 工具 | 用途 | 额外过滤器 | 主要响应字段 |
|---|
GetReportDashboard | 汇总 KPI 与图表数据 | test_mode、country、device_os | summary、chart_data |
GetReportBidders | 竞价方级表现 | test_mode、country、device_os | bidders |
GetReportApps | 应用级表现 | test_mode、country、device_os | apps |
GetReportAdUnits | 广告单元级表现 | test_mode、country、device_os、app_bundle、ad_unit_type | ad_units |
GetReportExport | JSON 形态的原始导出行 | country、device_os | columns、rows、row_count |
SearchDocs | CloudX 文档检索 | 无 | results |
报表工具参数
| 参数 | 必填 | 适用工具 | 说明 |
|---|
start_time | 是 | 报表工具 | UTC 的 Unix 秒时间戳 |
end_time | 是 | 报表工具 | UTC 的 Unix 秒时间戳 |
country | 否 | 报表工具 | ISO-2 国家代码 |
device_os | 否 | 报表工具 | iOS 或 Android |
test_mode | 否 | Dashboard、Bidders、Apps、Ad Units | production、test 或 all |
app_bundle | 否 | 仅 Ad Units | Bundle ID，例如 com.example.game |
ad_unit_type | 否 | 仅 Ad Units | BANNER、INTERSTITIAL、REWARDED、MREC 或 NATIVE |
GetReportDashboard
用于跨时间范围的总体报表。
适用场景
- 总收入与填充率检查
- 每日趋势分析
- 按国家或平台快速健康检查
| 参数 | 类型 | 必填 |
|---|
start_time | integer | 是 |
end_time | integer | 是 |
country | string | 否 |
device_os | string | 否 |
test_mode | string | 否 |
响应结构
summary 包含 total_requests、total_impressions、revenue、fill_rate、ecpm、total_clicks、ctr、total_users 等字段。
GetReportBidders
用于对比需求合作伙伴。
适用场景
- 找出收入最高的竞价方
- 按合作伙伴检查竞价率与胜出率
- 跨国家或平台比较供给质量
| 参数 | 类型 | 必填 |
|---|
start_time | integer | 是 |
end_time | integer | 是 |
country | string | 否 |
device_os | string | 否 |
test_mode | string | 否 |
响应结构
每个竞价方行可包含 name、requests、bids、bid_rate、impressions、win_rate、revenue 与 ecpm。
GetReportApps
用于在账户内比较应用级表现。
适用场景
- 按收入对应用排序
- 比较 iOS 与 Android 投放组合表现
- 发现填充率较低的应用
| 参数 | 类型 | 必填 |
|---|
start_time | integer | 是 |
end_time | integer | 是 |
country | string | 否 |
device_os | string | 否 |
test_mode | string | 否 |
响应结构
每个应用行可包含 app_id、name、platform、impressions、fill_rate、revenue 与 ecpm。
GetReportAdUnits
用于广告位级别的深入分析。
适用场景
- 比较 banner、激励视频与插屏广告
- 限定到单个应用 bundle
- 找出表现较弱或价值较高的广告位
| 参数 | 类型 | 必填 |
|---|
start_time | integer | 是 |
end_time | integer | 是 |
country | string | 否 |
device_os | string | 否 |
test_mode | string | 否 |
app_bundle | string | 否 |
ad_unit_type | string | 否 |
响应结构
每行可包含 ad_unit_id、name、app_name、app_bundle、type、impressions、fill_rate、revenue 与 ecpm。
GetReportExport
需要表格化数据而非汇总报表时使用此工具。
适用场景
- 将数据传入电子表格
- 校验下游分析
- 将结构化行交给其他工具或代理
| 参数 | 类型 | 必填 |
|---|
start_time | integer | 是 |
end_time | integer | 是 |
country | string | 否 |
device_os | string | 否 |
响应结构
SearchDocs
在 MCP 客户端中检索 CloudX 文档，在回答关于安装、配置、SDK、CLI、Dashboard、网络或报表的问题前使用。
适用场景
- 为某个 CloudX 工作流找到对应的文档页
- 在解释功能前以最新文档作为依据
- 不离开 AI 客户端即可获取相关的安装或排错片段
| 参数 | 类型 | 必填 | 说明 |
|---|
body.query | string | 是 | 自然语言检索查询 |
工具调用结构
{
"name": "SearchDocs",
"arguments": {
"body": {
"query": "report filters"
}
}
}
响应结构
每条结果包含：
content：匹配到的文档片段path：文档路径，例如 /en/cli/reportingurl：绝对文档 URLmetadata：页面元数据（标题等，若可用）
错误行为
无法满足请求时，这些工具会返回 MCP 错误结果。常见的报表错误原因：
- 缺少
start_time 或 end_time
- 枚举值无效，例如
device_os: "ios" 而非 iOS
- 所选账户或时间范围在后端校验时报错
对于 SearchDocs，空白或缺失的查询会返回 query is required。文档检索暂时不可用时，工具会返回 docs search error。
相关链接
