MCP Tool Inventory¶
This document describes the business tool capabilities currently callable via MCP by the OWL MCP Server, including tool classification, permission types, usage conventions, 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 required resource or operation permissions, the corresponding tool call may fail or return empty results.
Note
OWL MCP Server uses the facade mode by default. The client will first see three wrapper tools: list_catalogs, list_tools, and exec_tool. The server can also enable the static mode, which directly exposes the allowed business tools in the MCP tools/list and hides specified tools according to the server block list. Some tools are only available in the OWL CLI and cannot be executed via MCP (for example, dashboard-related tools). The actual visible tools are subject to the client's tools/list result.
Tool Scope¶
The business tools executable by OWL MCP Server will be continuously updated with the platform capabilities. The actual executable tools are subject to the tool catalog returned by list_catalogs and list_tools.
This document covers the following business categories:
| Category | Description |
|---|---|
account |
Workspace discovery within 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 list, incident comments, operation records, and on-call schedules |
infrastructure |
Host, container, process, and other infrastructure object queries |
llm |
LLM observability application list queries |
member |
Workspace member queries |
mdsearch |
Unified document corpus search, document reading, and directory 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 Recommendation |
|---|---|---|
| Read-only | Queries, searches, detail retrieval, sample validation, etc., that do not modify workspace resources | Can be opened to Agent auto-invocation 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¶
In facade mode, the MCP client should call in the following order:
- Call
list_catalogsto view available categories. - Call
list_tools, passingcatalog_id, to view the business tools and parameters under that category. - Call
exec_tool, passingtool_nameandparameters, to execute the business tool.
In static mode, the client can directly call the business tools returned by tools/list without going through the three wrapper tools. Regardless of the mode used, the tool parameters and permission requirements remain the same.
| Type | Convention |
|---|---|
| Time range | Use 13-digit millisecond timestamps uniformly |
| Pagination parameters | Typically use page_size and page_index |
| Detail queries | Usually rely on identifiers such as 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 | Subject to the actual tool response |
Tool Overview¶
| Toolset | Tool | Function | Permission |
|---|---|---|---|
| account | owl.account.workspace.same_org.list |
Lists workspaces in the same organization as the current API Key workspace | Read-only |
| catalog | owl.catalog.entity_type_query |
Queries entity types supported by the unified catalog | Read-only |
| catalog | owl.catalog.entity_query |
Queries entity list by entity type | Read-only |
| catalog | owl.catalog.entity_get |
Gets single entity details by urn |
Read-only |
| catalog | owl.catalog.entity_topology_query |
Queries topology relationships associated with a single entity | Read-only |
| data | owl.data.show_dql_namespace |
Views DQL namespaces | Read-only |
| data | owl.data.simple_query |
Automatically assembles query statements using simplified parameters | Read-only |
| data | owl.data.same_org.trace.query |
Queries a Trace by trace_id in the current or same-organization workspace |
Read-only |
| data | owl.metric.list |
Discovers available source or fields for metric queries |
Read-only |
| data | owl.rum.list |
Discovers available source or fields for RUM queries |
Read-only |
| data | owl.apm.list |
Discovers available source or fields for APM queries |
Read-only |
| data | owl.network.list |
Discovers available source or fields for Network queries |
Read-only |
| data | owl.profile.list |
Discovers available source or fields for Profile queries |
Read-only |
| data | owl.logging.list |
Discovers available source or fields for log queries |
Read-only |
| data | owl.logging.cluster_task.create |
Creates an asynchronous log clustering task | Read-only |
| data | owl.logging.cluster_task.get |
Gets the result of a log clustering task | Read-only |
| data | owl.billing.list |
Discovers available source or fields for cloud billing queries |
Read-only |
| data | owl.slo.list |
Queries the SLO list of the current workspace | Read-only |
| data | owl.log_index.list |
Lists available indices for log queries | Read-only |
| data | owl.log_index.get |
Queries details of a single log index | Read-only |
| data | owl.field_schema.get |
Queries the current field catalog | Read-only |
| errors | owl.errors.list |
Queries the error center issue list | Read-only |
| errors | owl.errors.comment.add |
Adds a comment to an error issue | Write |
| errors | owl.errors.comment.list |
Queries the comment list under an error issue | Read-only |
| errors | owl.errors.comment.update |
Updates an existing error comment | Write |
| event | owl.event.list |
Queries the event list | Read-only |
| event | owl.event.get |
Queries a single event detail | Read-only |
| incident | owl.incident.list |
Queries the incident list | Read-only |
| incident | owl.incident_comment.list |
Queries the incident comment list | Read-only |
| incident | owl.incident_comment.add |
Adds a comment to an incident | Write |
| incident | owl.incident_operation.list |
Queries incident operation records | Read-only |
| incident | owl.incident_schedule.list |
Queries the on-call schedule list | Read-only |
| incident | owl.incident_schedule.get |
Queries on-call schedule details | Read-only |
| infrastructure | owl.infrastructure.list |
Queries the infrastructure object list | Read-only |
| infrastructure | owl.infrastructure.get |
Queries a single infrastructure object detail | Read-only |
| llm | owl.llm.list |
Queries the LLM application list | Read-only |
| member | owl.member.list |
Queries the workspace member list | Read-only |
| mdsearch | mdsearch_search |
Searches the unified document corpus and returns candidate documents | Read-only |
| mdsearch | mdsearch_document |
Reads a complete document by id or path | Read-only |
| mdsearch | mdsearch_catalog |
Browses the directory structure of the document corpus | Read-only |
| monitor | owl.monitor.list |
Queries the monitor list | Read-only |
| monitor | owl.monitor.upsert |
Creates a monitor or updates an existing monitor | Write |
| monitor | owl.monitor.receive |
Sends an external event to an existing receiver, or creates a receiver first then sends the event | Write |
| monitor | owl.monitor.get |
Queries monitor details | Read-only |
| nbook_note | owl.nbook_note.list |
Queries note summaries visible to the current account | Read-only |
| nbook_note | owl.nbook_note.get |
Gets note details and Markdown body | Read-only |
| nbook_note | owl.nbook_note.add |
Creates a note | Write |
| nbook_note | owl.nbook_note.modify |
Modifies a note | Write |
| nbook_note | owl.nbook_note.delete |
Deletes a note | Write |
| pipeline | owl.pipeline.list |
Queries the Pipeline list and returns decoded content | Read-only |
| pipeline | owl.pipeline.validate |
Validates 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 input parameter for owl.data.same_org.trace.query for cross-workspace Trace queries.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.account.workspace.same_org.list |
Lists workspaces in the same organization as the current workspace, sorted by workspace id descending | 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;workspace_idis only used for list pagination and should not be passed to the Trace query tool.
Catalog¶
Used for entity type discovery, entity query, entity detail retrieval, and topology relationship query in the unified resource catalog.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.catalog.entity_type_query |
Queries 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 |
Queries entity list by entity type | Query the Catalog entity list of type host |
entity_type, page_size, page_index |
Read-only |
owl.catalog.entity_get |
Gets single entity details by urn |
Query the entity details corresponding to this urn |
urn |
Read-only |
owl.catalog.entity_topology_query |
Queries 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 their usage.
Data¶
Used for DQL namespace exploration, data source and field discovery, log index discovery, SLO queries, log clustering, cross-workspace Trace queries within the same organization, and simplified data queries for MCP clients. Currently, the MCP side provides simplified query and query assistant tools, not full DQL or PromQL custom execution tools.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.data.show_dql_namespace |
Lists currently supported DQL namespaces and indicates whether index is supported |
List currently supported DQL namespaces | None | Read-only |
owl.data.simple_query |
Automatically assembles query statements using 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 |
Queries a Trace by trace_id in the current or same-organization workspace |
Query a Trace across multiple workspaces in the same organization | trace_id, workspace_uuids, start_time, end_time, where_clause, source, limit |
Read-only |
owl.metric.list |
Discovers available source or fields for metric queries |
List available sources in the metric domain | mode |
Read-only |
owl.rum.list |
Discovers available source or fields for RUM queries |
List available fields in the RUM domain | mode |
Read-only |
owl.apm.list |
Discovers available source or fields for APM queries |
Query available sources in the APM domain | mode |
Read-only |
owl.network.list |
Discovers available source or fields for Network queries |
List available fields in the Network domain | mode |
Read-only |
owl.profile.list |
Discovers available source or fields for Profile queries |
View available sources in the Profile domain | mode |
Read-only |
owl.logging.list |
Discovers available source or fields for log queries |
List available sources in the log domain | mode, source |
Read-only |
owl.logging.cluster_task.create |
Creates an asynchronous log clustering task, returns task_id |
Cluster recent error logs by similar messages | timeRange, analysisField, namespace, conditions, query, indexes |
Read-only |
owl.logging.cluster_task.get |
Gets the log clustering result by task_id |
Query the result of this log clustering task | task_id |
Read-only |
owl.billing.list |
Discovers available source or fields for cloud billing queries |
List available sources for cloud billing | mode, source |
Read-only |
owl.slo.list |
Queries the SLO list of the current workspace, supports search by name or monitor UUID | List SLOs of the current workspace | search |
Read-only |
owl.log_index.list |
Lists available indices for log queries | List current log indices | None | Read-only |
owl.log_index.get |
Queries details of a single log index | Query details of this log index UUID | index_uuid |
Read-only |
owl.field_schema.get |
Queries the current field catalog, used to complete query fields | List currently available field catalog | None | Read-only |
When
workspace_uuidsinowl.data.same_org.trace.queryis omitted or passed as an empty array, only the current workspace is queried. When the cross-workspace query within the same organization is disabled, only the current workspace is allowed to 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 Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.errors.list |
Queries 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 |
Adds 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 |
Queries the comment list under an error issue | View the comment records of this error issue | issue_id, page_size, page_index |
Read-only |
owl.errors.comment.update |
Updates 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 Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.event.list |
Queries the event list | Query critical events in the last 1 hour | start_time, end_time, status, limit |
Read-only |
owl.event.get |
Queries a single event detail, can limit the event time range | Query the details of this event doc_id within the specified time range |
doc_id, timeRange |
Read-only |
owl.event.listmust providestart_timeandend_time; optionalstatusvalues arefatal,critical,error,warning, andnodata;limitdefaults to 20, maximum is 100; the return may include the event dimension tag fielddf_dimension_tags.timeRangeforowl.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 querying incident lists, incident comments, operation records, and on-call schedules.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.incident.list |
Queries the incident list | Query all current incidents | search, page_size, page_index |
Read-only |
owl.incident_comment.list |
Queries the incident comment list | View the comment records of this incident | incident_uuid |
Read-only |
owl.incident_comment.add |
Adds a comment to an incident | Add a progress update comment to this incident | incident_uuid, comment |
Write |
owl.incident_operation.list |
Queries incident operation records | View the operation history of this incident | incident_uuid, page_size, page_index |
Read-only |
owl.incident_schedule.list |
Queries the on-call schedule list | Query the current on-call schedule list | search, page_size, page_index |
Read-only |
owl.incident_schedule.get |
Queries on-call schedule details | 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, and processes.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.infrastructure.list |
Queries the infrastructure object list | Query all current host objects | resource_type, limit, filters |
Read-only |
owl.infrastructure.get |
Queries a single infrastructure object detail | Query the detailed information of this container object | resource_type, identity_value |
Read-only |
LLM¶
Used for LLM observability application list queries.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.llm.list |
Queries 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 searching by name or email keyword.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.member.list |
Queries 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 Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.monitor.list |
Queries the monitor list | Query currently enabled monitors | search, status_list |
Read-only |
owl.monitor.upsert |
Creates a monitor or updates an existing monitor | Create a new external event monitor | json_script, rule_uuid, status, secret, alert_policy_uuids, tags |
Write |
owl.monitor.receive |
Sends an external event to an existing receiver, or creates a receiver first then sends the event | Send a test event to this monitor | event, target, monitor, extra_data |
Write |
owl.monitor.get |
Queries monitor details | Query the full 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 Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.nbook_note.list |
Queries visible note summaries, does not return Markdown body | Search for notes whose title or body contains specified content, or filter by type or tags | page_index, page_size, search, tags, tagkv_query, type |
Read-only |
owl.nbook_note.get |
Gets note details and Markdown body by note_uuid |
Read the full Markdown body of this note | note_uuid |
Read-only |
owl.nbook_note.add |
Creates a note and returns the note summary | Create a Markdown note with tags | title, content, tags, tag_kv, type |
Write |
owl.nbook_note.modify |
Modifies a note by note_uuid and returns the updated summary |
Update the title, body, or tags of this note | note_uuid, title, content, tags, tag_kv |
Write |
owl.nbook_note.delete |
Deletes a note by note_uuid |
Delete this note | note_uuid |
Write |
- For
owl.nbook_note.list,page_indexdefaults to 1,page_sizedefaults to 20, maximum is 100. owl.nbook_note.getis the only note tool that returns the Markdown bodycontent, but does not returnpath,etag, orversion;list,add, andmodifyonly return summaries, notcontent,path, ETag, or version information;deleteresponse retains the original compact structure from the backend.typesupportsnormalandrunbook.owl.nbook_note.listcan filter bytype; when omitted, no type filter is applied.owl.nbook_note.addcan settype; when omitted, the backend creates anormalnote. Responses ofgetandmodifyincludetype, butget,modify, anddeletedo not accepttypeas input parameter; the type of an existing note cannot be modified.owl.nbook_note.addmust providetitleandcontent, and does not acceptpath;created_sourceis always set toaiby the server, and the creator account 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 managed by the backend such aspath,etag,if_match,version,creator, orcreated_source. tagkv_queryis a TagKV expression string used by the list tool;tag_kvis a key-value object used by create and modify tools. Do not mix them up.
Pipeline¶
Used for Pipeline list queries and sample validation.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
owl.pipeline.list |
Queries the Pipeline list and returns decoded content | List Pipelines whose name contains nginx | search, scope, categories |
Read-only |
owl.pipeline.validate |
Validates Pipeline processing results with sample data | Validate whether this Pipeline can correctly parse this log sample | content, testData, dataType |
Read-only |
mdsearch¶
Used for searching the unified document corpus, reading a complete document by id or path, and browsing the corpus directory structure. Supports Chinese, English, and mixed queries.
| Tool Name | Function | Example Question | Key Parameters | Permission |
|---|---|---|---|---|
mdsearch_search |
Searches the unified document corpus and returns sorted candidate documents | Search for documents containing "DQL time range" | q, top, path_prefix, tags, mode, sort |
Read-only |
mdsearch_document |
Reads a complete document by id or path |
Read the full content of this document id | id, meta |
Read-only |
mdsearch_catalog |
Browses the top-level directories and representative documents of the document corpus | See what directories are in the document corpus | None | Read-only |
MCP Usage Paths¶
The following steps use the default facade mode as an example. If the server enables static mode, you can directly call the business tools with the same name without going through exec_tool.
Data Query Problems¶
Applicable to problems such as "query metrics, logs, RUM, APM, Network, Profile data".
- Call
owl.data.show_dql_namespaceviaexec_toolto confirm the data namespace. - Based on the data domain, call the discovery tool via
exec_tool: - 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 indices:
owl.log_index.list - Field catalog:
owl.field_schema.get - After obtaining the necessary
source,field,index, execute the query viaexec_toolcallingowl.data.simple_query.
Incident Troubleshooting Problems¶
Applicable to problems such as "query incidents, track incident handling process, add incident comments".
- Call
owl.incident.listviaexec_toolto query incidents. - Based on the incident
incident_uuid, call viaexec_tool: owl.incident_comment.listto view commentsowl.incident_operation.listto view operation records- When needing to add processing information, call
owl.incident_comment.addviaexec_tool.
Resource Object Location Problems¶
Applicable to problems such as "query details of infrastructure objects like hosts, containers, processes".
- Call
owl.infrastructure.listviaexec_toolto find the target object. - Based on the identification information in the returned results, call
owl.infrastructure.getviaexec_toolto get the object details.
Cross-Workspace Trace Query Problems¶
Applicable to problems such as "query a Trace by trace_id across multiple workspaces in the same organization".
- Call
owl.account.workspace.same_org.listviaexec_toolto discover candidate workspaces in the same organization. - Extract
workspace_uuidfrom the returned results (do not useworkspace_id). - Call
owl.data.same_org.trace.queryviaexec_tool, passing the requiredtrace_id, and the selectedworkspace_uuidasworkspace_uuids; when omitted or passed as an empty array, only the current workspace is queried. - If additional filtering is needed, use a
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¶
Applicable to problems such as "search, read, create, modify, or delete notes".
- Call
owl.nbook_note.listviaexec_toolto search for notes and obtain thenote_uuid. - To read the Markdown body, call
owl.nbook_note.get. - To create a note, call
owl.nbook_note.add; to update, callowl.nbook_note.modify. - To delete, call
owl.nbook_note.delete;add,modify, anddeleteare write tools, and manual confirmation should be performed by the client before execution.
Monitor Management Problems¶
Applicable to problems such as "query monitors, create or update monitors, send external events".
- Call
owl.monitor.listviaexec_toolto query monitors. - Based on the
rule_uuidin the returned results, callowl.monitor.getviaexec_toolto view monitor details. - To create or update a monitor, call
owl.monitor.upsertviaexec_tool. - To send an external event, call
owl.monitor.receiveviaexec_tool.