跳转至

MCP 工具清单


本文档介绍 OWL MCP Server 当前可通过 MCP 调用的业务工具能力,包括工具分类、权限类型、使用约定、工具总览,以及典型 MCP 使用路径。

工具可见范围和调用结果取决于当前接入使用的 API Key 权限。若 API Key 没有相关资源或操作权限,对应工具调用可能会失败,或返回空结果。

注意

OWL MCP Server 默认使用 facade 模式,客户端会先看到 list_catalogs、list_tools、exec_tool 三个包装工具。服务端也可以启用 static 模式,在 MCP tools/list 中直接暴露允许调用的业务工具,并按服务端排除列表隐藏指定工具。部分工具仅在 OWL CLI 中提供,不能通过 MCP 执行(例如仪表板相关工具);实际可见工具以客户端的 tools/list 结果为准。

工具范围

OWL MCP Server 可执行的业务工具会随平台能力持续更新。实际可执行工具以 list_catalogs 和 list_tools 返回的工具目录为准。

当前文档覆盖以下业务分类:

分类 说明
account 同组织工作空间发现
catalog 统一资源目录、实体类型、实体详情和拓扑关系
data 数据源/字段发现、日志索引发现、SLO、日志聚类、计费发现、简化数据查询和同组织跨空间 Trace 查询
errors 错误中心问题查询和评论管理
event 事件列表查询和事件详情获取
incident 故障列表与详情、关联事件引用、故障评论、操作记录和值班排班
infrastructure 主机、容器、进程等基础设施对象查询
llm LLM 可观测应用列表查询
workspace 跨空间数据查询授权范围发现、当前空间成员查询
mdsearch 统一文档语料检索、文档读取和目录浏览
monitor 监控器查询、创建、更新和外部事件接收
nbook_note 笔记的查询、读取、创建、修改和删除
pipeline Pipeline 列表查询和样例验证

权限类型

权限类型 含义 使用建议
只读 查询、检索、获取详情、验证样例等不会修改工作空间资源 可按需开放给 Agent 自动调用
写入 创建、更新、追加评论、接收外部事件等会修改工作空间资源 建议在 Agent 客户端中配置人工确认

使用约定

facade 模式下,MCP 客户端应按以下顺序调用:

  1. 调用 list_catalogs 查看可用分类。
  2. 调用 list_tools,传入 catalog_id,查看该分类下的业务工具和参数。
  3. 调用 exec_tool,传入 tool_name 和 parameters 执行业务工具。

static 模式下,客户端可以直接调用 tools/list 返回的业务工具,无需经过三个包装工具。无论使用哪种模式,工具参数和权限要求保持一致。

类型 约定
时间范围 统一使用 13 位毫秒时间戳
分页参数 通常使用 page_size 和 page_index
详情查询 通常依赖列表工具返回的 UUID、ID、URN 等标识
数据查询 建议先调用发现类工具获取 source、field、index,再调用查询类工具
返回结构 以实际工具响应为准

工具总览

工具集 工具 功能 权限
account owl.account.workspace.same_org.list 列出与当前 API Key 工作空间同组织的工作空间 只读
catalog owl.catalog.entity_type_query 查询统一目录支持的实体类型 只读
catalog owl.catalog.entity_query 按实体类型查询实体列表 只读
catalog owl.catalog.entity_get 按 urn 获取单个实体详情 只读
catalog owl.catalog.entity_topology_query 查询单个实体关联的拓扑关系 只读
data owl.data.show_dql_namespace 查看 DQL namespace 只读
data owl.data.simple_query 通过简化参数自动组装查询语句 只读
data owl.data.same_org.trace.query 按 trace_id 查询当前或同组织工作空间中的 Trace 只读
data owl.metric.list 发现指标查询可用的 source 或字段 只读
data owl.rum.list 发现 RUM 查询可用的 source 或字段 只读
data owl.apm.list 发现 APM 查询可用的 source 或字段 只读
data owl.network.list 发现 Network 查询可用的 source 或字段 只读
data owl.profile.list 发现 Profile 查询可用的 source 或字段 只读
data owl.logging.list 发现日志查询可用的 source 或字段 只读
data owl.logging.cluster_task.create 创建日志聚类分析异步任务 只读
data owl.logging.cluster_task.get 获取日志聚类分析任务结果 只读
data owl.billing.list 发现云账单查询可用的 source 或字段 只读
data owl.slo.list 查询当前空间的 SLO 列表 只读
data owl.log_index.list 列出日志查询可用的索引 只读
data owl.log_index.get 查询单个日志索引详情 只读
data owl.field_schema.get 查询当前字段目录 只读
errors owl.errors.list 查询错误中心问题列表 只读
errors owl.errors.comment.add 给错误问题新增评论 写入
errors owl.errors.comment.list 查询错误问题下的评论列表 只读
errors owl.errors.comment.update 更新已有错误评论 写入
event owl.event.list 查询事件列表 只读
event owl.event.get 查询单个事件详情 只读
incident owl.incident.list 查询故障列表 只读
incident owl.incident.get 查询故障详情与分页关联事件引用 只读
incident owl.incident_comment.list 查询故障评论列表 只读
incident owl.incident_comment.add 给故障单新增评论 写入
incident owl.incident_operation.list 查询故障操作记录 只读
incident owl.incident_schedule.list 查询值班排班列表 只读
incident owl.incident_schedule.get 查询值班排班详情 只读
infrastructure owl.infrastructure.list 查询基础设施对象列表 只读
infrastructure owl.infrastructure.get 查询单个基础设施对象详情 只读
llm owl.llm.list 查询 LLM 应用列表 只读
workspace owl.workspace.data_authorized.list 按站点列出当前空间已有数据查询授权的空间 只读
workspace owl.workspace.member.list 查询空间成员列表 只读
mdsearch mdsearch_search 检索统一文档语料,返回候选文档 只读
mdsearch mdsearch_document 按 id 或 path 读取完整文档 只读
mdsearch mdsearch_catalog 浏览文档语料的目录结构 只读
monitor owl.monitor.list 查询监控器列表 只读
monitor owl.monitor.upsert 创建监控器或更新已有监控器 写入
monitor owl.monitor.receive 向已有接收端发送外部事件,或先创建接收器再发送事件 写入
monitor owl.monitor.get 查询监控器详情 只读
nbook_note owl.nbook_note.list 查询当前账号可见的笔记摘要 只读
nbook_note owl.nbook_note.get 获取笔记详情和 Markdown 正文 只读
nbook_note owl.nbook_note.add 创建笔记 写入
nbook_note owl.nbook_note.modify 修改笔记 写入
nbook_note owl.nbook_note.delete 删除笔记 写入
pipeline owl.pipeline.list 查询 Pipeline 列表并返回解码后的内容 只读
pipeline owl.pipeline.validate 用样例数据验证 Pipeline 处理结果 只读

Account

同组织发现使用下表工具。得到的 workspace_uuid 可作为 owl.data.same_org.trace.query 的 workspace_uuids 入参,用于跨工作空间 Trace 查询。

工具名 功能 可提问示例 关键参数 权限
owl.account.workspace.same_org.list 列出与当前工作空间同组织的工作空间,按 workspace id 降序 列出与当前空间同组织的工作空间 workspace_uuids、page_size、before_workspace_id 只读

注意:返回结果中的 workspace_uuid 才是后续 workspace_uuids 入参;workspace_id 只用于列表分页,不要传给 Trace 查询工具。

Catalog

用于统一资源目录的实体类型发现、实体查询、实体详情获取和拓扑关系查询。

工具名 功能 可提问示例 关键参数 权限
owl.catalog.entity_type_query 查询统一目录支持的实体类型 列出当前 Catalog 支持的实体类型 page_size、page_index 只读
owl.catalog.entity_query 按实体类型查询实体列表 查询 host 类型的 Catalog 实体列表 entity_type、page_size、page_index 只读
owl.catalog.entity_get 按 urn 获取单个实体详情 查询这个 urn 对应的实体详情 urn 只读
owl.catalog.entity_topology_query 查询单个实体关联的拓扑关系 查看这个主机实体的上下游拓扑 urn 只读

注意:仪表板工具(owl.dashboard.create / owl.dashboard.replace / owl.dashboard.get)仅在 OWL CLI 中提供,不会出现在 MCP 工具列表中,相关用法请参见 OWL CLI 文档。

Data

授权查询空间通过 owl.workspace.data_authorized.list 发现,支持 region_code、search、page_index、page_size,各站点独立分页。将 workspace_uuid 和 region_code 传给 owl.data.simple_query 的 workspace_uuids 和 target_region,即可查询同一目标站点内的多个授权空间。详见跨空间查询说明。

用于 DQL namespace 探查、数据源和字段发现、日志索引发现、SLO 查询、日志聚类分析、同组织跨工作空间 Trace 查询,以及面向 MCP 客户端的简化数据查询。当前 MCP 侧提供的是简化查询和查询辅助工具,不包含完整 DQL 或 PromQL 自定义执行工具。

工具名 功能 可提问示例 关键参数 权限
owl.data.show_dql_namespace 列出当前支持的 DQL namespace,并标明是否支持 index 列出当前支持的 DQL namespace 无 只读
owl.data.simple_query 通过简化参数自动组装查询语句 用简单查询方式统计最近 30 分钟 CPU 使用率 namespace、start_time、end_time、source、select_clause、where_clause、group_by_clause、index、workspace_uuids、target_region 只读
owl.data.same_org.trace.query 按 trace_id 查询当前或同组织工作空间中的 Trace 查询一条跨多个同组织工作空间的 Trace trace_id、workspace_uuids、start_time、end_time、where_clause、source、limit 只读
owl.metric.list 发现指标查询可用的 source 或字段 列出指标域可用的 source mode 只读
owl.rum.list 发现 RUM 查询可用的 source 或字段 列出 RUM 域可用的字段 mode 只读
owl.apm.list 发现 APM 查询可用的 source 或字段 查询 APM 域可用的 source mode 只读
owl.network.list 发现 Network 查询可用的 source 或字段 列出 Network 域可用字段 mode 只读
owl.profile.list 发现 Profile 查询可用的 source 或字段 查看 Profile 域可用的 source mode 只读
owl.logging.list 发现日志查询可用的 source 或字段 列出日志域可用的 source mode、source 只读
owl.logging.cluster_task.create 创建日志聚类分析异步任务,返回 task_id 把最近的错误日志按相似消息聚类 timeRange、analysisField、namespace、conditions、query、indexes 只读
owl.logging.cluster_task.get 按 task_id 获取日志聚类分析结果 查询这个日志聚类任务的结果 task_id 只读
owl.billing.list 发现云账单查询可用的 source 或字段 列出云账单可用的 source mode、source 只读
owl.slo.list 查询当前空间的 SLO 列表,支持按名称或监控器 UUID 检索 列出当前空间的 SLO search 只读
owl.log_index.list 列出日志查询可用的索引 列出当前日志索引 无 只读
owl.log_index.get 查询单个日志索引详情 查询这个日志索引 UUID 的详情 index_uuid 只读
owl.field_schema.get 查询当前字段目录,用于补全查询字段 列出当前可用字段目录 无 只读

owl.data.same_org.trace.query 的 workspace_uuids 省略或传空数组时只查询当前工作空间。同组织跨工作空间查询功能关闭时,只允许查询当前工作空间;传入其他工作空间 UUID 会返回参数错误。

Errors

用于错误中心的问题列表查询,以及评论的新增、查询和更新。

工具名 功能 可提问示例 关键参数 权限
owl.errors.list 查询错误中心问题列表 查询最近 24 小时的错误问题列表 start_time、end_time、page_size、page_index、conditions、assigner、issue_status 只读
owl.errors.comment.add 给错误问题新增评论 给这个错误问题补一条排查评论 issue_id、comment、attachment_uuids、extend 写入
owl.errors.comment.list 查询错误问题下的评论列表 查看这个错误问题的评论记录 issue_id、page_size、page_index 只读
owl.errors.comment.update 更新已有错误评论 更新这条错误评论的内容 comment_uuid、comment、attachment_uuids、extend 写入

Event

用于事件中心列表查询和事件详情获取。

工具名 功能 可提问示例 关键参数 权限
owl.event.list 查询事件列表 查询最近 1 小时的 critical 事件 start_time、end_time、status、limit 只读
owl.event.get 查询单个事件详情,可限定事件时间范围 查询这个事件 doc_id 在指定时间范围内的详情 doc_id、timeRange 只读
  • owl.event.list 必须提供 start_time 和 end_time;status 可选值为 fatal、critical、error、warning 和 nodata,limit 默认值为 20、最大值为 100;返回项可能包含事件维度标签字段 df_dimension_tags。
  • owl.event.get 的 timeRange 为可选的二元素数组 [start, end],元素均为 13 位毫秒时间戳,且 end 必须大于 start。参数名为 timeRange,不要改写为 time_range。

Incident

owl.incident.get 接受故障 UUID(incident_*),返回详情及 related_event_refs。关联引用每页默认及上限 100,按 page_info.has_more 和 next_page_index 读取后续页,再根据事件引用调用 owl.event.get;不要将故障 UUID 当作事件文档 ID。引用总数与故障报告的事件总数可能不同,应保留并说明缺失的证据。

用于故障列表与详情、关联事件引用、故障评论、操作记录和值班排班查询。

工具名 功能 可提问示例 关键参数 权限
owl.incident.list 查询故障列表 查询当前所有故障单 search、page_size、page_index 只读
owl.incident.get 查询故障详情与分页关联事件引用 获取故障来源、发生时间和关联事件 incident_uuid、page_size、page_index 只读
owl.incident_comment.list 查询故障评论列表 查看这个故障单的评论记录 incident_uuid 只读
owl.incident_comment.add 给故障单新增评论 给这个故障单补一条处理进展 incident_uuid、comment 写入
owl.incident_operation.list 查询故障操作记录 查看这个故障单的操作历史 incident_uuid、page_size、page_index 只读
owl.incident_schedule.list 查询值班排班列表 查询当前值班排班列表 search、page_size、page_index 只读
owl.incident_schedule.get 查询值班排班详情 查询这个值班排班的详细配置 schedule_uuid 只读

Infrastructure

用于基础设施对象列表和详情查询,覆盖主机、容器、进程等资源对象。

工具名 功能 可提问示例 关键参数 权限
owl.infrastructure.list 查询基础设施对象列表 查询当前所有主机对象 resource_type、limit、filters 只读
owl.infrastructure.get 查询单个基础设施对象详情 查询这个容器对象的详细信息 resource_type、identity_value 只读

LLM

用于 LLM 可观测应用列表查询。

工具名 功能 可提问示例 关键参数 权限
owl.llm.list 查询 LLM 应用列表 列出当前所有 LLM 应用 search、type、page_size、page_index 只读

Workspace

用于跨空间数据查询授权范围发现,以及当前空间成员列表查询和按姓名、邮箱关键字检索。

工具名 功能 可提问示例 关键参数 权限
owl.workspace.data_authorized.list 列出向当前空间授予数据查询权限的空间 跨空间查询前确认可查空间 region_code、search、page_index、page_size 只读
owl.workspace.member.list 查询空间成员列表 搜索邮箱里包含 alice 的成员 search 只读

owl.member.list 保留为显式调用的兼容别名,不作为独立工具列出;CLI 需升级到支持别名的版本后执行 owl sync。

Monitor

用于监控器列表查询、详情获取、创建或更新,以及外部事件接收。

工具名 功能 可提问示例 关键参数 权限
owl.monitor.list 查询监控器列表 查询当前启用的监控器 search、status_list 只读
owl.monitor.upsert 创建监控器或更新已有监控器 新建一个外部事件监控器 json_script、rule_uuid、status、secret、alert_policy_uuids、tags 写入
owl.monitor.receive 向已有接收端发送外部事件,或先创建接收器再发送事件 给这个监控器发送一条测试事件 event、target、monitor、extra_data 写入
owl.monitor.get 查询监控器详情 查询这个监控器规则的完整配置 rule_uuid 只读

笔记

用于管理当前 API Key 账号可见的笔记。

工具名 功能 可提问示例 关键参数 权限
owl.nbook_note.list 查询可见的笔记摘要,不返回 Markdown 正文 搜索标题或正文中包含指定内容的笔记,或按类型、标签过滤 page_index、page_size、search、tags、tagkv_query、type 只读
owl.nbook_note.get 按 note_uuid 获取笔记详情和 Markdown 正文 读取这篇笔记的完整 Markdown 正文 note_uuid 只读
owl.nbook_note.add 创建笔记并返回笔记摘要 创建一篇带标签的 Markdown 笔记 title、content、tags、tag_kv、type 写入
owl.nbook_note.modify 按 note_uuid 修改笔记并返回更新后的摘要 更新这篇笔记的标题、正文或标签 note_uuid、title、content、tags、tag_kv 写入
owl.nbook_note.delete 按 note_uuid 删除笔记 删除这篇笔记 note_uuid 写入
  • owl.nbook_note.list 的 page_index 默认值为 1,page_size 默认值为 20、最大值为 100。
  • owl.nbook_note.get 是唯一返回 Markdown 正文 content 的笔记工具,但不返回 path、etag 或 version;list、add 和 modify 只返回摘要,不返回 content、path、ETag 或版本信息;delete 响应保持后端原有精简结构。
  • type 支持 normal 和 runbook。owl.nbook_note.list 可按 type 过滤,省略时不过滤类型;owl.nbook_note.add 可设置 type,省略时后端创建 normal 笔记;get 和 modify 的响应会包含 type,但 get、modify、delete 都不接受 type 入参,已有笔记类型不可修改。
  • owl.nbook_note.add 必须提供 title 和 content,不接受 path;created_source 固定由服务端设为 ai,创建账号取自当前 API Key。
  • owl.nbook_note.modify 除 note_uuid 外,至少还要提供 title、content、tags 或 tag_kv 中的一项;省略 content 时保留原正文。
  • 获取、修改和删除都使用列表返回的 note_uuid。不要传 path、etag、if_match、version、creator 或 created_source 等由后端管理的字段。
  • tagkv_query 是列表工具使用的 TagKV 表达式字符串;tag_kv 是创建和修改工具使用的键值对象,两者不要混用。

Pipeline

用于 Pipeline 列表查询和样例验证。

工具名 功能 可提问示例 关键参数 权限
owl.pipeline.list 查询 Pipeline 列表并返回解码后的内容 列出名称包含 nginx 的 Pipeline search、scope、categories 只读
owl.pipeline.validate 用样例数据验证 Pipeline 处理结果 用这段日志样例验证这条 Pipeline 是否能正确解析 content、testData、dataType 只读

mdsearch

用于检索统一文档语料、按 id 或 path 读取完整文档,以及浏览语料目录结构,支持中文、英文及混合查询。

工具名 功能 可提问示例 关键参数 权限
mdsearch_search 检索统一文档语料并返回排序后的候选文档 搜索包含 “DQL 时间范围” 的文档 q、top、path_prefix、tags、mode、sort 只读
mdsearch_document 按 id 或 path 读取完整文档 读取这个文档 id 的完整内容 id、meta 只读
mdsearch_catalog 浏览文档语料的顶层目录和代表文档 看看文档语料有哪些目录 无 只读

MCP 使用路径

以下步骤以默认的 facade 模式为例。若服务端启用了 static 模式,可直接调用同名业务工具,无需经过 exec_tool。

数据查询类问题

适用于“查询指标、日志、RUM、APM、Network、Profile 数据”等问题。

  1. 通过 exec_tool 调用 owl.data.show_dql_namespace 确认数据 namespace。
  2. 根据数据域通过 exec_tool 调用发现类工具:
  3. 指标:owl.metric.list
  4. RUM:owl.rum.list
  5. APM:owl.apm.list
  6. Network:owl.network.list
  7. Profile:owl.profile.list
  8. 日志:owl.logging.list
  9. 云账单:owl.billing.list
  10. 日志索引:owl.log_index.list
  11. 字段目录:owl.field_schema.get
  12. 获取必要的 source、field、index 后,通过 exec_tool 调用 owl.data.simple_query 执行查询。

故障排查类问题

适用于“查询故障、追踪故障处理过程、补充故障评论”等问题。

  1. 已知故障 UUID 时,通过 exec_tool 调用 owl.incident.get;目标未确定时先调用 owl.incident.list。
  2. 按返回的分页信息读取全部关联事件引用,再调用 owl.event.get 获取事件内容。
  3. 使用 owl.incident_comment.list 查看评论、owl.incident_operation.list 查看操作记录。
  4. 需要补充处理信息时,通过 exec_tool 调用 owl.incident_comment.add。

资源对象定位类问题

适用于“查询主机、容器、进程等基础设施对象详情”的问题。

  1. 通过 exec_tool 调用 owl.infrastructure.list 查找目标对象。
  2. 根据返回结果中的标识信息,通过 exec_tool 调用 owl.infrastructure.get 获取对象详情。

跨工作空间 Trace 查询类问题

适用于“按 trace_id 查询一条跨同组织多个工作空间的 Trace”的问题。

  1. 本空间 Trace 直接查询;需要其他同组织空间且 UUID 未确定时,通过 exec_tool 调用 owl.account.workspace.same_org.list 发现候选空间。
  2. 从返回结果中取 workspace_uuid(不要取 workspace_id)。
  3. 通过 exec_tool 调用 owl.data.same_org.trace.query,传入必填的 trace_id,并将所选 workspace_uuid 作为 workspace_uuids;省略或传空数组时只查询当前工作空间。
  4. 如需附加过滤,使用不含外层花括号的 where_clause,且不要重复添加 trace_id 条件。跨工作空间 Trace 查询不要回退到 owl.data.simple_query。

笔记管理类问题

适用于“搜索、读取、创建、修改或删除笔记”等问题。

  1. 通过 exec_tool 调用 owl.nbook_note.list 搜索笔记并取得 note_uuid。
  2. 需要读取 Markdown 正文时,调用 owl.nbook_note.get。
  3. 创建笔记时调用 owl.nbook_note.add,更新时调用 owl.nbook_note.modify。
  4. 删除时调用 owl.nbook_note.delete;add、modify 和 delete 属于写入工具,执行前应由客户端进行人工确认。

监控器管理类问题

适用于“查询监控器、创建或更新监控器、发送外部事件”等问题。

  1. 通过 exec_tool 调用 owl.monitor.list 查询监控器。
  2. 根据返回结果中的 rule_uuid,通过 exec_tool 调用 owl.monitor.get 查看监控器详情。
  3. 如需创建或更新监控器,通过 exec_tool 调用 owl.monitor.upsert。
  4. 如需发送外部事件,通过 exec_tool 调用 owl.monitor.receive。

文档评价

文档内容是否对您有帮助?