MCP Tool List¶
This document describes the business tools currently available for invocation through MCP wrapper tools in the OWL MCP Server, including tool categories, permission types, usage conventions, a tool overview, and typical MCP usage paths.
The visibility and invocation results of tools depend on the permissions of the API Key currently in use. If the API Key does not have the necessary permissions for related resources or operations, the corresponding tool invocation may fail or return empty results.
Note
After the MCP client connects to the OWL MCP Server, it will first see three wrapper tools: list_catalogs, list_tools, and exec_tool. Business tools will not appear directly in the MCP tools/list results. Please first use list_catalogs and list_tools to discover catalogs, then execute business tools by passing the tool name and parameters through exec_tool. Some tools are only available in the OWL CLI and cannot be executed via MCP (e.g., dashboard-related tools). This document describes the MCP tool list accordingly.
Tool Scope¶
The business tools executable by the OWL MCP Server will be continuously updated with platform capabilities. The actual executable tools shall be based on the tool catalog returned by list_catalogs and list_tools.
This document currently covers the following business categories:
| Category | Description |
|---|---|
account |
Discovery of workspaces in the same organization |
catalog |
Unified resource catalog, entity types, entity details, and topology relationships |
data |
Data source/field discovery, log index discovery, SLO, log clustering, billing discovery, simplified data queries, and cross-workspace Trace queries within the same organization |
errors |
Error center issue queries and comment management |
event |
Event list queries and event detail retrieval |
incident |
Incident lists, incident comments, operation records, and on-call schedules |
infrastructure |
Infrastructure object queries for hosts, containers, processes, etc. |
llm |
LLM observable application list queries |
member |
Workspace member queries |
mdsearch |
Unified document corpus search, document reading, and catalog browsing |
monitor |
Monitor queries, creation, updates, and external event reception |
nbook_note |
Note queries, reading, creation, modification, and deletion |
pipeline |
Pipeline list queries and sample validation |
Permission Types¶
| Permission Type | Meaning | Usage Suggestion |
|---|---|---|
| Read-only | Queries, searches, detail retrieval, sample validation, etc., that do not modify workspace resources | Can be opened for automatic invocation by the Agent as needed |
| Write | Creation, updates, adding comments, receiving external events, etc., that modify workspace resources | It is recommended to configure manual confirmation in the Agent client |
Usage Conventions¶
The MCP client should call in the following order:
- Call
list_catalogsto view available categories. - Call
list_toolswith thecatalog_idparameter to view the business tools and their parameters under that category. - Call
exec_toolwithtool_nameandparametersto execute the business tool.
| Type | Convention |
|---|---|
| Time Range | Uniformly use 13-digit millisecond timestamps |
| Pagination Parameters | Typically use page_size and page_index |
| Detail Queries | Usually rely on identifiers like UUID, ID, URN returned by list tools |
| Data Queries | It is recommended to first call discovery tools to obtain source, field, index, then call query tools |
| Return Structure | Based on the actual tool response |
Tool Overview¶
| Toolset | Tool | Function | Permission |
|---|---|---|---|
| account | owl.account.workspace.same_org.list |
List workspaces in the same organization as the current API Key workspace | Read-only |
| catalog | owl.catalog.entity_type_query |
Query entity types supported by the unified catalog | Read-only |
| catalog | owl.catalog.entity_query |
Query entity lists by entity type | Read-only |
| catalog | owl.catalog.entity_get |
Get a single entity detail by urn |
Read-only |
| catalog | owl.catalog.entity_topology_query |
Query topology relationships associated with a single entity | Read-only |
| data | owl.data.show_dql_namespace |
View DQL namespace | Read-only |
| data | owl.data.simple_query |
Automatically assemble query statements with simplified parameters | Read-only |
| data | owl.data.same_org.trace.query |
Query trace by trace_id in the current or same-organization workspace |
Read-only |
| data | owl.metric.list |
Discover available source or fields for Metrics queries |
Read-only |
| data | owl.rum.list |
Discover available source or fields for RUM queries |
Read-only |
| data | owl.apm.list |
Discover available source or fields for APM queries |
Read-only |
| data | owl.network.list |
Discover available source or fields for Network queries |
Read-only |
| data | owl.profile.list |
Discover available source or fields for Profile queries |
Read-only |
| data | owl.logging.list |
Discover available source or fields for log queries |
Read-only |
| data | owl.logging.cluster_task.create |
Create an asynchronous log clustering analysis task | Read-only |
| data | owl.logging.cluster_task.get |
Get the results of a log clustering analysis task | Read-only |
| data | owl.billing.list |
Discover available source or fields for cloud billing queries |
Read-only |
| data | owl.slo.list |
Query the SLO list of the current workspace | Read-only |
| data | owl.log_index.list |
List available indexes for log queries | Read-only |
| data | owl.log_index.get |
Query a single log index detail | Read-only |
| data | owl.field_schema.get |
Query the current field catalog | Read-only |
| errors | owl.errors.list |
Query the error center issue list | Read-only |
| errors | owl.errors.comment.add |
Add a comment to an error issue | Write |
| errors | owl.errors.comment.list |
Query the comment list under an error issue | Read-only |
| errors | owl.errors.comment.update |
Update an existing error comment | Write |
| event | owl.event.list |
Query the event list | Read-only |
| event | owl.event.get |
Query a single event detail | Read-only |
| incident | owl.incident.list |
Query the incident list | Read-only |
| incident | owl.incident_comment.list |
Query the incident comment list | Read-only |
| incident | owl.incident_comment.add |
Add a comment to an incident ticket | Write |
| incident | owl.incident_operation.list |
Query incident operation records | Read-only |
| incident | owl.incident_schedule.list |
Query the on-call schedule list | Read-only |
| incident | owl.incident_schedule.get |
Query the on-call schedule detail | Read-only |
| infrastructure | owl.infrastructure.list |
Query the infrastructure object list | Read-only |
| infrastructure | owl.infrastructure.get |
Query a single infrastructure object detail | Read-only |
| llm | owl.llm.list |
Query the LLM application list | Read-only |
| member | owl.member.list |
Query the workspace member list | Read-only |
| mdsearch | mdsearch_search |
Search the unified document corpus and return candidate documents | Read-only |
| mdsearch | mdsearch_document |
Read a complete document by id or path | Read-only |
| mdsearch | mdsearch_catalog |
Browse the document corpus catalog structure | Read-only |
| monitor | owl.monitor.list |
Query the monitor list | Read-only |
| monitor | owl.monitor.upsert |
Create a monitor or update an existing monitor | Write |
| monitor | owl.monitor.receive |
Send an external event to an existing receiver, or create a receiver first and then send the event | Write |
| monitor | owl.monitor.get |
Query monitor details | Read-only |
| nbook_note | owl.nbook_note.list |
Query note summaries visible to the current account | Read-only |
| nbook_note | owl.nbook_note.get |
Get note details and Markdown content | Read-only |
| nbook_note | owl.nbook_note.add |
Create a note | Write |
| nbook_note | owl.nbook_note.modify |
Modify a note | Write |
| nbook_note | owl.nbook_note.delete |
Delete a note | Write |
| pipeline | owl.pipeline.list |
Query the Pipeline list and return decoded content | Read-only |
| pipeline | owl.pipeline.validate |
Validate Pipeline processing results with sample data | Read-only |
Account¶
Used to discover other workspaces in the same organization as the current API Key workspace. The obtained workspace_uuid can be used as the workspace_uuids parameter for owl.data.same_org.trace.query for cross-workspace Trace queries.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.account.workspace.same_org.list |
List workspaces in the same organization as the current workspace, sorted by workspace id in descending order | List workspaces in the same organization as the current workspace | workspace_uuids, page_size, before_workspace_id |
Read-only |
Note: The
workspace_uuidin the returned results is the parameter for subsequentworkspace_uuids. Theworkspace_idis only used for list pagination and should not be passed to the Trace query tool.
Catalog¶
Used for entity type discovery, entity queries, entity detail retrieval, and topology relationship queries in the unified resource catalog.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.catalog.entity_type_query |
Query entity types supported by the unified catalog | List entity types supported by the current Catalog | page_size, page_index |
Read-only |
owl.catalog.entity_query |
Query entity lists by entity type | Query the Catalog entity list of type host |
entity_type, page_size, page_index |
Read-only |
owl.catalog.entity_get |
Get a single entity detail by urn |
Query the entity detail for this urn |
urn |
Read-only |
owl.catalog.entity_topology_query |
Query topology relationships associated with a single entity | View the upstream and downstream topology of this host entity | urn |
Read-only |
Note: Dashboard tools (
owl.dashboard.create/owl.dashboard.replace/owl.dashboard.get) are only available in the OWL CLI and will not appear in the MCP tool list. Please refer to the OWL CLI documentation for usage.
Data¶
Used for DQL namespace exploration, data source and field discovery, log index discovery, SLO queries, log clustering analysis, cross-workspace Trace queries within the same organization, and simplified data queries for MCP clients. The MCP side currently provides simplified query and query assistant tools, not full DQL or PromQL custom execution tools.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.data.show_dql_namespace |
List currently supported DQL namespaces and indicate whether index is supported |
List currently supported DQL namespaces | None | Read-only |
owl.data.simple_query |
Automatically assemble query statements with simplified parameters | Use simple query to calculate CPU usage in the last 30 minutes | namespace, start_time, end_time, source, select_clause, where_clause, group_by_clause, index |
Read-only |
owl.data.same_org.trace.query |
Query trace by trace_id in the current or same-organization workspace |
Query a trace spanning multiple workspaces in the same organization | trace_id, workspace_uuids, start_time, end_time, where_clause, source, limit |
Read-only |
owl.metric.list |
Discover available source or fields for Metrics queries |
List available sources in the Metrics domain | mode |
Read-only |
owl.rum.list |
Discover available source or fields for RUM queries |
List available fields in the RUM domain | mode |
Read-only |
owl.apm.list |
Discover available source or fields for APM queries |
Query available sources in the APM domain | mode |
Read-only |
owl.network.list |
Discover available source or fields for Network queries |
List available fields in the Network domain | mode |
Read-only |
owl.profile.list |
Discover available source or fields for Profile queries |
View available sources in the Profile domain | mode |
Read-only |
owl.logging.list |
Discover available source or fields for log queries |
List available sources in the log domain | mode, source |
Read-only |
owl.logging.cluster_task.create |
Create an asynchronous log clustering analysis task, returning task_id |
Cluster recent error logs by similar messages | timeRange, analysisField, namespace, conditions, query, indexes |
Read-only |
owl.logging.cluster_task.get |
Get log clustering analysis results by task_id |
Query the results of this log clustering task | task_id |
Read-only |
owl.billing.list |
Discover available source or fields for cloud billing queries |
List available sources for cloud billing | mode, source |
Read-only |
owl.slo.list |
Query the SLO list of the current workspace, supporting search by name or monitor UUID | List SLOs in the current workspace | search |
Read-only |
owl.log_index.list |
List available indexes for log queries | List current log indexes | None | Read-only |
owl.log_index.get |
Query a single log index detail | Query the detail of this log index UUID | index_uuid |
Read-only |
owl.field_schema.get |
Query the current field catalog for completing query fields | List currently available field catalogs | None | Read-only |
When
workspace_uuidsinowl.data.same_org.trace.queryis omitted or an empty array is passed, only the current workspace is queried. When the cross-workspace query within the same organization is disabled, only the current workspace can be queried. Passing other workspace UUIDs will return a parameter error.
Errors¶
Used for querying the error center issue list, and adding, querying, and updating comments.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.errors.list |
Query the error center issue list | Query the list of error issues in the last 24 hours | start_time, end_time, page_size, page_index, conditions, assigner, issue_status |
Read-only |
owl.errors.comment.add |
Add a comment to an error issue | Add a troubleshooting comment to this error issue | issue_id, comment, attachment_uuids, extend |
Write |
owl.errors.comment.list |
Query the comment list under an error issue | View the comment records for this error issue | issue_id, page_size, page_index |
Read-only |
owl.errors.comment.update |
Update an existing error comment | Update the content of this error comment | comment_uuid, comment, attachment_uuids, extend |
Write |
Event¶
Used for event center list queries and event detail retrieval.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.event.list |
Query the event list | Query critical events in the last 1 hour | start_time, end_time, status, limit |
Read-only |
owl.event.get |
Query a single event detail, with an optional event time range | Query the detail of this event doc_id within a specified time range |
doc_id, timeRange |
Read-only |
owl.event.listmust providestart_timeandend_time. The optional values forstatusarefatal,critical,error,warning, andnodata. The default value oflimitis 20, with a maximum of 100. The returned items may include the event dimension tag fielddf_dimension_tags.- The
timeRangeofowl.event.getis an optional two-element array[start, end], both elements are 13-digit millisecond timestamps, andendmust be greater thanstart. The parameter name istimeRange, do not change it totime_range.
Incident¶
Used for incident list, incident comments, operation records, and on-call schedule queries.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.incident.list |
Query the incident list | Query all current incident tickets | search, page_size, page_index |
Read-only |
owl.incident_comment.list |
Query the incident comment list | View the comment records for this incident ticket | incident_uuid |
Read-only |
owl.incident_comment.add |
Add a comment to an incident ticket | Add a progress update to this incident ticket | incident_uuid, comment |
Write |
owl.incident_operation.list |
Query incident operation records | View the operation history for this incident ticket | incident_uuid, page_size, page_index |
Read-only |
owl.incident_schedule.list |
Query the on-call schedule list | Query the current on-call schedule list | search, page_size, page_index |
Read-only |
owl.incident_schedule.get |
Query the on-call schedule detail | Query the detailed configuration of this on-call schedule | schedule_uuid |
Read-only |
Infrastructure¶
Used for infrastructure object list and detail queries, covering resource objects such as hosts, containers, processes, etc.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.infrastructure.list |
Query the infrastructure object list | Query all current host objects | resource_type, limit, filters |
Read-only |
owl.infrastructure.get |
Query a single infrastructure object detail | Query the detailed information of this container object | resource_type, identity_value |
Read-only |
LLM¶
Used for LLM observable application list queries.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.llm.list |
Query the LLM application list | List all current LLM applications | search, type, page_size, page_index |
Read-only |
Member¶
Used for workspace member list queries and search by name or email keyword.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.member.list |
Query the workspace member list | Search for members whose email contains alice |
search |
Read-only |
Monitor¶
Used for monitor list queries, detail retrieval, creation or update, and external event reception.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.monitor.list |
Query the monitor list | Query currently enabled monitors | search, status_list |
Read-only |
owl.monitor.upsert |
Create a monitor or update an existing monitor | Create a new external event monitor | json_script, rule_uuid, status, secret, alert_policy_uuids, tags |
Write |
owl.monitor.receive |
Send an external event to an existing receiver, or create a receiver first and then send the event | Send a test event to this monitor | event, target, monitor, extra_data |
Write |
owl.monitor.get |
Query monitor details | Query the complete configuration of this monitor rule | rule_uuid |
Read-only |
Notes¶
Used to manage notes visible to the current API Key account.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.nbook_note.list |
Query visible note summaries, without returning Markdown content | Search for notes with specified content in the title or body, or filter by type or tags | page_index, page_size, search, tags, tagkv_query, type |
Read-only |
owl.nbook_note.get |
Get note details and Markdown content by note_uuid |
Read the full Markdown content of this note | note_uuid |
Read-only |
owl.nbook_note.add |
Create a note and return the note summary | Create a Markdown note with tags | title, content, tags, tag_kv, type |
Write |
owl.nbook_note.modify |
Modify a note by note_uuid and return the updated summary |
Update the title, body, or tags of this note | note_uuid, title, content, tags, tag_kv |
Write |
owl.nbook_note.delete |
Delete a note by note_uuid |
Delete this note | note_uuid |
Write |
- The default value of
page_indexinowl.nbook_note.listis 1, the default value ofpage_sizeis 20, with a maximum of 100. owl.nbook_note.getis the only note tool that returns the Markdown contentcontent, but does not returnpath,etag, orversion.list,add, andmodifyonly return summaries, notcontent,path, ETag, or version information. Thedeleteresponse maintains the original concise structure from the backend.typesupportsnormalandrunbook.owl.nbook_note.listcan filter bytype, and when omitted, no type filtering is applied.owl.nbook_note.addcan settype, and when omitted, the backend creates anormalnote. Thegetandmodifyresponses includetype, butget,modify, anddeletedo not accepttypeas a parameter. The note type of an existing note cannot be modified.owl.nbook_note.addmust providetitleandcontent, and does not acceptpath.created_sourceis fixed toaiby the server, and the creator is taken from the current API Key.owl.nbook_note.modifymust provide at least one oftitle,content,tags, ortag_kvin addition tonote_uuid. Whencontentis omitted, the original body is preserved.- Retrieval, modification, and deletion all use the
note_uuidreturned by the list. Do not pass fields likepath,etag,if_match,version,creator, orcreated_sourcethat are managed by the backend. tagkv_queryis a TagKV expression string used by the list tool.tag_kvis a key-value object used by the creation and modification tools. Do not mix them.
Pipeline¶
Used for Pipeline list queries and sample validation.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
owl.pipeline.list |
Query the Pipeline list and return decoded content | List Pipelines with names containing nginx | search, scope, categories |
Read-only |
owl.pipeline.validate |
Validate Pipeline processing results with sample data | Use this log sample to verify if this Pipeline can parse correctly | content, testData, dataType |
Read-only |
mdsearch¶
Used to search the unified document corpus, read complete documents by id or path, and browse the corpus catalog structure. Supports Chinese, English, and mixed queries.
| Tool Name | Function | Example Query | Key Parameters | Permission |
|---|---|---|---|---|
mdsearch_search |
Search the unified document corpus and return sorted candidate documents | Search for documents containing "DQL time range" | q, top, path_prefix, tags, mode, sort |
Read-only |
mdsearch_document |
Read a complete document by id or path |
Read the full content of this document id | id, meta |
Read-only |
mdsearch_catalog |
Browse the top-level catalog and representative documents of the document corpus | View the catalogs available in the document corpus | None | Read-only |
MCP Usage Paths¶
Data Query Problems¶
Suitable for problems like "Query metrics, logs, RUM, APM, Network, Profile data".
- Use
exec_toolto callowl.data.show_dql_namespaceto confirm the data namespace. - Use
exec_toolto call discovery tools based on the data domain: - Metrics:
owl.metric.list - RUM:
owl.rum.list - APM:
owl.apm.list - Network:
owl.network.list - Profile:
owl.profile.list - Logs:
owl.logging.list - Cloud Billing:
owl.billing.list - Log Indexes:
owl.log_index.list - Field Catalog:
owl.field_schema.get - After obtaining the necessary
source,field, andindex, useexec_toolto callowl.data.simple_queryto execute the query.
Incident Troubleshooting Problems¶
Suitable for problems like "Query incidents, trace the incident handling process, add incident comments".
- Use
exec_toolto callowl.incident.listto query incident tickets. - Based on the
incident_uuidof the incident ticket, useexec_toolto call: owl.incident_comment.listto view commentsowl.incident_operation.listto view operation records- When supplementary handling information is needed, use
exec_toolto callowl.incident_comment.add.
Resource Object Locating Problems¶
Suitable for problems like "Query details of infrastructure objects such as hosts, containers, processes".
- Use
exec_toolto callowl.infrastructure.listto find the target object. - Based on the identification information in the returned results, use
exec_toolto callowl.infrastructure.getto get the object details.
Cross-Workspace Trace Query Problems¶
Suitable for problems like "Query a trace spanning multiple workspaces in the same organization by trace_id".
- Use
exec_toolto callowl.account.workspace.same_org.listto discover candidate workspaces in the same organization. - Extract
workspace_uuidfrom the returned results (do not useworkspace_id). - Use
exec_toolto callowl.data.same_org.trace.query, passing the requiredtrace_idand the selectedworkspace_uuidasworkspace_uuids. When omitted or an empty array is passed, only the current workspace is queried. - If additional filtering is needed, use
where_clausewithout outer curly braces, and do not add thetrace_idcondition again. Do not fall back toowl.data.simple_queryfor cross-workspace Trace queries.
Note Management Problems¶
Suitable for problems like "Search, read, create, modify, or delete notes".
- Use
exec_toolto callowl.nbook_note.listto search for notes and obtainnote_uuid. - When needing to read the Markdown content, call
owl.nbook_note.get. - Call
owl.nbook_note.addto create a note, andowl.nbook_note.modifyto update. - Call
owl.nbook_note.deleteto delete.add,modify, anddeleteare write tools, and manual confirmation by the client should be performed before execution.
Monitor Management Problems¶
Suitable for problems like "Query monitors, create or update monitors, send external events".
- Use
exec_toolto callowl.monitor.listto query monitors. - Based on the
rule_uuidin the returned results, useexec_toolto callowl.monitor.getto view monitor details. - To create or update a monitor, use
exec_toolto callowl.monitor.upsert. - To send an external event, use
exec_toolto callowl.monitor.receive.