Skip to content

Add Tools section to all toolset documentation pages #2044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aantn wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add Tools section to all toolset documentation pages #2044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bf9930
docs: add Tools section to builtin toolset pages and Grafana companio…
claude May 6, 2026
0296fc4
docs: consolidate Tools sections in builtin toolset docs
claude May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/data-sources/builtin-toolsets/aks-node-health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,18 @@ toolsets:
max_unhealthy_nodes: 3 # Maximum number of unhealthy nodes to report
```

## Capabilities
## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| aks_check_node_health | Perform comprehensive health checks on AKS nodes |
| aks_get_node_metrics | Get detailed metrics for AKS nodes |
| aks_diagnose_node_issues | Diagnose common node-level issues |
| aks_check_node_readiness | Check if nodes are ready and schedulable |
| aks_get_node_events | Get events related to specific nodes |
| aks_check_node_resources | Check resource utilization on nodes |
| check_node_status | Checks the status of all nodes in the AKS cluster. |
| describe_node | Describes a specific node in the AKS cluster to inspect its conditions. |
| get_node_events | Fetches recent events for a specific node to surface warnings and errors. |
| check_node_resource_usage | Shows CPU/memory usage for a specific node (requires metrics-server). |
| review_activity_log | Reviews the Azure Activity Log for recent changes affecting the node. |
| check_top_resource_consuming_pods | Checks for the top resource-consuming pods on a specific node. |
| check_network_outbound | Checks the outbound network connectivity for an AKS cluster. |
| check_network_inbound | Checks the inbound network connectivity for an AKS cluster. |
| list_vmss_names | Lists all VMSS names in the cluster node resource group. |
25 changes: 18 additions & 7 deletions docs/data-sources/builtin-toolsets/aks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,24 @@ toolsets:
timeout: 60 # Request timeout in seconds
```

## Capabilities
## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| aks_get_cluster_info | Get detailed information about the AKS cluster |
| aks_get_node_pools | List and describe AKS node pools |
| aks_get_cluster_credentials | Get cluster credentials for kubectl access |
| aks_scale_node_pool | Scale a specific node pool |
| aks_get_cluster_logs | Fetch AKS cluster logs |
| aks_get_addon_status | Get status of AKS addons |
| cloud_provider | Fetch the cloud provider of the Kubernetes cluster from node providerIDs |
| aks_get_cluster | Get the configuration details of a specific AKS cluster |
| aks_list_clusters_by_rg | List all AKS clusters under a specific resource group |
| aks_list_node_pools | List node pools in an AKS cluster |
| aks_show_node_pool | Show details of a specific node pool in an AKS cluster |
| aks_list_versions | List supported Kubernetes versions in a region |
| aks_get_credentials | Download kubeconfig file for an AKS cluster |
| aks_list_addons | List all available AKS addons |
| get_default_subscription | Retrieve the current Azure CLI default subscription ID |
| get_cluster_name | Retrieve the active Kubernetes cluster name from kubeconfig |
| get_cluster_resource_group | Retrieve the resource group name for the AKS cluster |
| get_node_resource_group | Retrieve the node resource group name for the AKS cluster |
| get_api_server_public_ip | Get the public IP of kube-apiserver for a public AKS cluster |
| get_all_nsgs | Get all Network Security Group (NSG) instances in a subscription |
| get_nsg_rules | Get all NSG rules associated with a specific NSG |
5 changes: 3 additions & 2 deletions docs/data-sources/builtin-toolsets/argocd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,18 @@ This is the recommended approach if your ArgoCD is reachable through a public DN

In production, always use a Kubernetes secret instead of hardcoding the token value in your Helm values.

## Capabilities
## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| argocd_app_list | List the applications in ArgoCD |
| argocd_app_get | Retrieve information about an existing application, such as its status and configuration |
| argocd_app_diff | Display the differences between the current state of an application and the desired state from Git |
| argocd_app_manifests | Retrieve manifests for an application |
| argocd_app_resources | List resources of an application |
| argocd_app_diff | Display the differences between the current state of an application and the desired state specified in its Git repository |
| argocd_app_manifest_source_revision | Get manifests for a multi-source application at a specific revision and source |
| argocd_app_history | List the deployment history of an application in ArgoCD |
| argocd_repo_list | List all the Git repositories that ArgoCD is currently managing |
| argocd_proj_list | List all available projects |
Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/builtin-toolsets/azure-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,3 +335,15 @@ kubectl exec -it HOLMES_POD -n YOUR_NAMESPACE -- \
```
"Our Azure costs increased 50% last week"
```

## Tools

This toolset proxies tools from the upstream Azure API MCP server. The full set of tools (and their descriptions) is defined by the MCP server itself — see the [Azure API MCP server documentation](https://github.com/Azure/azure-api-mcp) for the authoritative list.

Common capabilities exposed to HolmesGPT include:

- Compute and AKS resource inspection (VMs, node pools, workloads)
- Azure Monitor, Activity Log, and diagnostics queries
- Networking, storage, and database service investigation
- SQL / PostgreSQL and other managed data service lookups
- Identity, RBAC, and subscription metadata access
24 changes: 13 additions & 11 deletions docs/data-sources/builtin-toolsets/azure-sql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,17 +215,19 @@ Database Level (SQL permissions):

In addition, Query Store should be enabled on target databases

## Capabilities
## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| analyze_database_health_status | Analyze overall database health and status |
| analyze_database_performance | Analyze database performance metrics |
| analyze_database_connections | Analyze database connection patterns and issues |
| analyze_database_storage | Analyze database storage usage and growth |
| get_top_cpu_queries | Get queries with highest CPU usage |
| get_slow_queries | Get slowest performing queries |
| get_top_data_io_queries | Get queries with highest data I/O usage |
| get_top_log_io_queries | Get queries with highest log I/O usage |
| get_active_alerts | Get active alerts for the database |
| analyze_connection_failures | Analyze connection failure patterns |
| analyze_database_health_status | Analyzes the overall health status of an Azure SQL database including active operations, resource usage alerts, and system status |
| analyze_database_performance | Analyzes database performance including automatic tuning status, performance advisors, and active recommendations |
| analyze_database_connections | Analyzes database connection patterns, active connections, and connection pool utilization |
| analyze_database_storage | Analyzes database storage utilization including disk usage, growth trends, file-level details, and table space consumption |
| get_top_cpu_queries | Identifies the top CPU-consuming queries from Query Store |
| get_slow_queries | Identifies the slowest/longest-running queries from Query Store |
| get_top_data_io_queries | Identifies queries consuming the most data I/O (logical reads/writes) from Query Store |
| get_top_log_io_queries | Identifies queries consuming the most transaction log I/O from Query Store |
| get_active_alerts | Retrieves currently active Azure Monitor alerts for the SQL database and server |
| analyze_connection_failures | Analyzes connection failures, firewall blocks, and connection patterns for Azure SQL Database |
98 changes: 43 additions & 55 deletions docs/data-sources/builtin-toolsets/cilium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,61 +68,6 @@ toolsets:
timeout: 120 # Extended timeout for flow monitoring
```

## Capabilities

### Cilium/Core Toolset

| Tool Name | Description |
|-----------|-------------|
| cilium_status | Display overall Cilium agent status and health |
| cilium_status_verbose | Display detailed Cilium agent status with verbose output |
| cilium_version | Show Cilium version information |
| cilium_config | Display current Cilium configuration |
| cilium_endpoint_list | List all Cilium endpoints (pods with networking) |
| cilium_endpoint_get | Get detailed information about a specific endpoint by ID |
| cilium_endpoint_health | Check health status of all endpoints |
| cilium_endpoint_logs | Show logs for a specific endpoint |
| cilium_service_list | List all Cilium services and load balancer mappings |
| cilium_service_get | Get detailed information about a specific service by ID |
| cilium_loadbalancer_list | List load balancer backend mappings |
| cilium_policy_get | Get network policies applied to an endpoint |
| cilium_policy_trace | Trace policy decisions for traffic between source and destination |
| cilium_policy_trace_verbose | Detailed policy trace with verbose output |
| cilium_monitor | Monitor Cilium datapath events in real-time |
| cilium_monitor_verbose | Monitor datapath events with verbose output |
| cilium_node_list | List all nodes in the Cilium cluster |
| cilium_clustermesh_status | Display cluster mesh status for multi-cluster networking |
| cilium_bpf_map_list | List all BPF maps used by Cilium |
| cilium_bpf_endpoint_list | List endpoints from BPF maps |
| cilium_debuginfo | Generate debug information bundle for troubleshooting |

### Hubble/Observability Toolset

| Tool Name | Description |
|-----------|-------------|
| hubble_observe | Observe network flows in real-time (last 1000 flows) |
| hubble_observe_follow | Follow network flows in real-time as they happen |
| hubble_observe_namespace | Observe flows for a specific namespace |
| hubble_observe_pod | Observe flows to/from a specific pod |
| hubble_observe_since | Observe flows since a specific time |
| hubble_observe_http | Observe HTTP traffic flows |
| hubble_observe_dns | Observe DNS queries and responses |
| hubble_observe_kafka | Observe Kafka protocol traffic |
| hubble_observe_grpc | Observe gRPC traffic flows |
| hubble_observe_drops | Show only dropped network flows (policy denials, etc.) |
| hubble_observe_denied | Show flows denied by network policies |
| hubble_observe_service | Observe flows to/from a specific service |
| hubble_observe_port | Observe flows on a specific port |
| hubble_observe_from_pod | Observe flows originating from a specific pod |
| hubble_observe_to_pod | Observe flows destined to a specific pod |
| hubble_observe_between_namespaces | Observe flows between two specific namespaces |
| hubble_observe_json | Output flow observations in JSON format for detailed analysis |
| hubble_status | Display Hubble server status and configuration |
| hubble_list_nodes | List nodes available for flow observation |
| hubble_observe_flows_summary | Get a summary of recent network flows with basic statistics |
| hubble_observe_security_events | Observe security-related network events and policy violations |
| hubble_observe_l7_denied | Show L7 (application-layer) traffic that was denied |

## Use Cases

### Network Connectivity Troubleshooting
Expand Down Expand Up @@ -170,3 +115,46 @@ toolsets:
1. Examine service backends: `cilium_service_get`
2. Check BPF load balancer state: `cilium_loadbalancer_list`
3. Monitor service traffic: `hubble_observe_service`

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| cilium_status | Display overall Cilium agent status and health |
| cilium_status_verbose | Display detailed Cilium agent status with verbose output |
| cilium_version | Show Cilium version information |
| cilium_config | Display current Cilium configuration |
| cilium_connectivity_test | Run comprehensive connectivity tests to validate network functionality (slow) |
| cilium_connectivity_test_namespace | Run connectivity tests in a specific namespace (slow) |
| cilium_clustermesh_status | Display cluster mesh status for multi-cluster networking |
| cilium_features_status | Report which features are enabled in Cilium agents |
| cilium_bgp_peers | List BGP peers for nodes running Cilium |
| cilium_bgp_routes | List BGP routes for nodes running Cilium |
| cilium_encryption_status | Show encryption status and configuration |
| cilium_sysdump | Collect system information for troubleshooting Cilium issues |
| cilium_install_status | Check Cilium installation status in the cluster |
| cilium_context | Display the current Kubernetes context configuration |
| cilium_multicast_groups | List multicast groups and their members |
| hubble_observe | Observe network flows in real-time (last 100 flows) |
| hubble_observe_namespace | Observe flows for a specific namespace |
| hubble_observe_pod | Observe flows to/from a specific pod |
| hubble_observe_since | Observe flows since a specific time |
| hubble_observe_http | Observe HTTP traffic flows |
| hubble_observe_dns | Observe DNS queries and responses |
| hubble_observe_grpc | Observe gRPC traffic flows |
| hubble_observe_drops | Show only dropped network flows |
| hubble_observe_forwarded | Show flows that were successfully forwarded |
| hubble_observe_service | Observe flows to/from a specific service |
| hubble_observe_port | Observe flows on a specific port |
| hubble_observe_from_pod | Observe flows originating from a specific pod |
| hubble_observe_to_pod | Observe flows destined to a specific pod |
| hubble_observe_between_namespaces | Observe flows between two specific namespaces |
| hubble_observe_json | Output flow observations in JSON format |
| hubble_status | Display Hubble server status and configuration |
| hubble_list_nodes | List nodes available for flow observation |
| hubble_observe_flows_summary | Get a summary of recent network flows |
| hubble_observe_security_events | Observe security-related network events and policy violations |
| hubble_observe_policy_verdicts | Show policy verdict events (allows and denies) |
| hubble_observe_l7_traffic | Show L7 (application-layer) traffic flows |
Comment thread
coderabbitai[bot] marked this conversation as resolved.
2 changes: 1 addition & 1 deletion docs/data-sources/builtin-toolsets/confluence-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ You'll also need:
helm upgrade --install robusta robusta/robusta -f generated_values.yaml --set clusterName=YOUR_CLUSTER_NAME
```

## Available Tools
## Tools

| Tool | Description |
|------|-------------|
Expand Down
6 changes: 4 additions & 2 deletions docs/data-sources/builtin-toolsets/connectivity-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ holmes:
enabled: true
```

## Capabilities
## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| tcp_check | Check if a TCP socket can be opened to a host and port. Useful for testing basic network connectivity to services |
| tcp_check | Check if a TCP socket can be opened to a host and port |

## Examples

Expand Down
8 changes: 8 additions & 0 deletions docs/data-sources/builtin-toolsets/coralogix-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,11 @@ Custom Coralogix metrics:
- payments_failures: tracks payment processing failures
- api_latency_p95: 95th percentile API latency
```

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| coralogix_execute_dataprime_query | Execute a DataPrime query against Coralogix to fetch logs, traces, metrics, and other telemetry data |
22 changes: 22 additions & 0 deletions docs/data-sources/builtin-toolsets/crossplane.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,28 @@ HolmesGPT needs read access to Crossplane CRDs. If you use Kubernetes RBAC, ensu

--8<-- "snippets/helm_upgrade_command.md"

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

| Tool Name | Description |
|-----------|-------------|
| crossplane_list_providers | List all installed Crossplane providers with health status, version, and package reference |
| crossplane_get_provider | Get detailed status of a specific Crossplane provider including conditions and revision |
| crossplane_list_provider_revisions | List provider revisions to check for version rollout issues or stuck upgrades |
| crossplane_list_provider_configs | List ProviderConfigs of a specific type to check credential configurations |
| crossplane_get_provider_config | Get detailed ProviderConfig including credential source and configuration |
| crossplane_list_xrds | List all CompositeResourceDefinitions (XRDs) |
| crossplane_get_xrd | Get details of a specific XRD including schema, claim names, and offered versions |
| crossplane_list_compositions | List all Compositions which define how composite resources map to managed resources |
| crossplane_get_composition | Get details of a specific Composition including resource templates and patch sets |
| crossplane_get_claim | Get a Crossplane claim's full status including conditions and connection details |
| crossplane_get_composite_resource | Get a composite resource (XR) including status, conditions, and composed references |
| crossplane_list_managed_resources | List managed resources of a specific kind with sync and ready status |
| crossplane_get_managed_resource | Get full details of a specific managed resource including conditions and external name |
| crossplane_get_resource_events | Get Kubernetes events for a specific Crossplane resource |
| crossplane_list_managed_by_composite | List all managed resources owned by a specific composite resource |

## Common Use Cases

```bash
Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/builtin-toolsets/database-clickhouse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,18 @@ GRANT SELECT ON system.* TO holmes_readonly;
- **max_rows** (default: `200`): Maximum rows to return (1-10000)
- **llm_instructions**: Context about this database

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

Tool names are prefixed with the toolset name (e.g., for a toolset named `clickhouse-analytics`, tools are `clickhouse_analytics_query`, `clickhouse_analytics_list_tables`, etc.).

| Tool Name | Description |
|-----------|-------------|
| `<toolset_name>_query` | Execute a SQL query against the database (read-only by default) |
| `<toolset_name>_list_tables` | List all tables (and optionally views) in the database |
| `<toolset_name>_describe_table` | Get column definitions, constraints, primary/foreign keys, and indexes for a table |

## Common Use Cases

```
Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/builtin-toolsets/database-mariadb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,18 @@ FLUSH PRIVILEGES;
- **max_rows** (default: `200`): Maximum rows to return (1-10000)
- **llm_instructions**: Context about this database

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

Tool names are prefixed with the toolset name (e.g., for a toolset named `app-mariadb`, tools are `app_mariadb_query`, `app_mariadb_list_tables`, etc.).

| Tool Name | Description |
|-----------|-------------|
| `<toolset_name>_query` | Execute a SQL query against the database (read-only by default) |
| `<toolset_name>_list_tables` | List all tables (and optionally views) in the database |
| `<toolset_name>_describe_table` | Get column definitions, constraints, primary/foreign keys, and indexes for a table |

## Common Use Cases

```
Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/builtin-toolsets/database-mysql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,18 @@ FLUSH PRIVILEGES;
- **max_rows** (default: `200`): Maximum rows to return (1-10000)
- **llm_instructions**: Context about this database

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

Tool names are prefixed with the toolset name (e.g., for a toolset named `orders-rds`, tools are `orders_rds_query`, `orders_rds_list_tables`, etc.).

| Tool Name | Description |
|-----------|-------------|
| `<toolset_name>_query` | Execute a SQL query against the database (read-only by default) |
| `<toolset_name>_list_tables` | List all tables (and optionally views) in the database |
| `<toolset_name>_describe_table` | Get column definitions, constraints, primary/foreign keys, and indexes for a table |

## Common Use Cases

```
Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/builtin-toolsets/database-postgresql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,18 @@ GRANT pg_read_all_stats TO holmes_readonly;
- **max_rows** (default: `200`): Maximum rows to return (1-10000)
- **llm_instructions**: Context about this database

## Tools

--8<-- "snippets/toolset_capabilities_intro.md"

Tool names are prefixed with the toolset name (e.g., for a toolset named `prod-postgres`, tools are `prod_postgres_query`, `prod_postgres_list_tables`, etc.).

| Tool Name | Description |
|-----------|-------------|
| `<toolset_name>_query` | Execute a SQL query against the database (read-only by default) |
| `<toolset_name>_list_tables` | List all tables (and optionally views) in the database |
| `<toolset_name>_describe_table` | Get column definitions, constraints, primary/foreign keys, and indexes for a table |

## Common Use Cases

```
Expand Down
Loading
Loading