Skip to main content

How to Use

This guide explains how to query monitoring data using an AI assistant after connecting to the WhaTap MCP server.

How it works​

When you ask the AI assistant a question in natural language, it automatically handles the following steps.

  1. Retrieve project list — Identify the project code (pcode).

  2. Explore data catalog — Find what types of data are available.

  3. Execute query — Retrieve the requested data.

Tip

Start with "Show me my project list" to confirm your project code. Using the code in follow-up questions will produce more accurate results.

Available tools​

The MCP server provides 10 tools to the AI assistant. You do not need to call tools directly — just ask in natural language and the AI will automatically select the appropriate tool.

Project management tools​

ToolFunction
whatap_list_projectsList all monitoring projects (pcode, name, platform)
whatap_project_infoRetrieve detailed information for a specific project
whatap_list_agentsList agents (servers/instances) within a project

Data exploration tools​

ToolFunction
whatap_data_availabilityBrowse 900+ MXQL queries across 20+ categories, detect live data, list OpenMetrics metrics and saved PromQL queries
whatap_describe_queryRetrieve details for an MXQL path or OpenMetrics metric (parameters, output fields, metric type, recommended PromQL)
whatap_query_dataExecute MXQL, PromQL, or saved queries (results include unit conversion, thresholds, and analysis guidance)

Composite analysis tools​

ToolFunction
whatap_apm_anomalyAPM anomaly detection — simultaneously runs 4 queries (TPS, response time, errors, Active TX) for statistical analysis
whatap_service_topologyDetect service connections and network bottlenecks (requires NPM agent)

Installation and PromQL tools​

ToolFunction
whatap_install_agentGenerate agent installation commands for 29 platforms (auto-includes connection info, auto-detects platform)
whatap_create_promqlCreate, validate, and save PromQL queries (reusable)

Supported platforms for whatap_install_agent​

CategoryPlatforms
Infrastructure OSDebian/Ubuntu, Amazon Linux, RHEL/CentOS, SUSE, FreeBSD, Windows, and 3 more (9 total)
APMJava, Node.js, Python, PHP, .NET, Go
DatabasePostgreSQL, Oracle, MySQL, Redis, MongoDB, DB2, and 6 more (12 total)
ContainerKubernetes (Helm)
Server appsKafka, NGINX, Apache, and 4 more (7 total)

Tool usage flow​

Data query workflow (MXQL)

whatap_list_projects → Confirm project code
↓
whatap_data_availability(projectCode) → Check available MXQL paths
↓
whatap_describe_query(path) → Review parameters, fields, MXQL content
↓
whatap_query_data(projectCode, path) → Retrieve data

PromQL workflow (Kubernetes/OpenMetrics)

whatap_data_availability(projectCode) → Check OpenMetrics metric list
↓
whatap_create_promql(projectCode, name, query) → Validate and save PromQL
↓
whatap_query_data(projectCode, savedQuery="name") → Reuse saved query

Agent installation workflow

whatap_list_projects → Confirm projectCode + platform
↓
whatap_install_agent(projectCode) → Output connection info + installation commands
↓
whatap_list_agents(projectCode) → Verify agent registration
Tip

This flow is handled automatically by the AI. Just ask your question in natural language.

MXQL path reference​

Commonly used paths you can query directly without calling whatap_data_availability first.

DomainPathDescription
Serverv2/sys/server_baseCPU, memory, basic metrics
Serverv2/sys/server_diskDisk usage
Serverv2/sys/server_networkNetwork I/O
APMv2/app/tps_pcodeTPS (project-wide)
APMv2/app/resp_time_pcodeResponse time (project-wide)
APMv2/app/tx_error_pcodeError count (project-wide)
K8sv2/container/kube_podPod status
K8sv2/container/kube_nodeNode status
K8sv2/container/kube_eventCluster events
DBv2/db/instance_active_sessionActive sessions