manifest.json

{
  "manifest_version": "0.2",
  "name": "signoz",
  "display_name": "SigNoz MCP Server",
  "version": "0.11.0",
  "description": "Access SigNoz metrics, traces, logs, and dashboards.",
  "author": {
    "name": "SigNoz Team"
  },
  "homepage": "https://github.com/SigNoz/signoz-mcp-server",
  "documentation": "https://signoz.io/docs/signoz-mcp-server",
  "support": "https://github.com/SigNoz/signoz-mcp-server/issues",
  "icon": "signoz_icon.png",
  "server": {
    "type": "binary",
    "entry_point": "server/signoz-mcp-server",
    "mcp_config": {
      "command": "${__dirname}/server/signoz-mcp-server",
      "args": [],
      "env": {
        "SIGNOZ_URL": "${user_config.signoz_url}",
        "SIGNOZ_API_KEY": "${user_config.signoz_api_key}",
        "LOG_LEVEL": "${user_config.log_level}"
      }
    }
  },
  "tools": [
    {
      "name": "signoz_get_org_overview",
      "description": "Get the current status and overall posture of the SigNoz deployment, with typed telemetry, infrastructure, alert, workspace, authentication, licensing, and configuration projections plus sourceStats containing every reported stats field"
    },
    {
      "name": "signoz_list_metrics",
      "description": "Discover active metric names and catalog metadata such as type, temporality, and monotonicity; use signoz_query_metrics for values or trends. Set source=\"meter\" for Cost Meter metrics"
    },
    {
      "name": "signoz_query_metrics",
      "description": "Query a known metric for scalar values, time-series trends, breakdowns, or formulas with metric-aware defaults; use signoz_list_metrics only when the metric name is unknown"
    },
    {
      "name": "signoz_get_top_metrics",
      "description": "Return the fixed top 100 metrics ranked by ingested sample volume with percentages for cost and volume analysis, not metric values or dependency usage"
    },
    {
      "name": "signoz_check_metric_usage",
      "description": "For up to 50 known metric names, return dashboard and alert references before a drop or reduction; a non-empty per-metric error means that result is partial, not unused"
    },
    {
      "name": "signoz_check_metric_cardinality",
      "description": "Return one metric's label or attribute keys sorted by cardinality with sample values; use signoz_check_metric_usage for dashboard and alert dependencies"
    },
    {
      "name": "signoz_get_field_keys",
      "description": "Discover available field names for filtering or grouping metrics, traces, or logs; use signoz_get_field_values after choosing a key"
    },
    {
      "name": "signoz_get_field_values",
      "description": "Get observed values for a known metrics, traces, or logs field key; use signoz_get_field_keys when the key is unknown"
    },
    {
      "name": "signoz_list_alerts",
      "description": "List firing/silenced/inhibited Alertmanager alert *instances* (not rule definitions) with optional alert-label and receiver filtering"
    },
    {
      "name": "signoz_list_alert_rules",
      "description": "List configured alert-rule summaries, including inactive/OK and disabled rules; use signoz_get_alert for one full definition"
    },
    {
      "name": "signoz_get_alert",
      "description": "Get one configured alert rule's full definition by id when a still-current definition is not already available for the prepared signoz_update_alert operation"
    },
    {
      "name": "signoz_get_alert_history",
      "description": "Get one configured alert rule's firing or state-transition history; defaults to six hours and paginates with data.nextCursor"
    },
    {
      "name": "signoz_create_alert",
      "description": "Create a v2 threshold/PromQL or v1 anomaly alert; direct routing resolves exact names with signoz_list_notification_channels, while confirmed v2 policy routing may omit channels"
    },
    {
      "name": "signoz_update_alert",
      "description": "Fully replace an alert using same-operation signoz_get_alert, authoring-resource, and signoz_list_notification_channels results; refresh only stale preflights"
    },
    {
      "name": "signoz_delete_alert",
      "description": "Permanently delete a confirmed alert rule by UUIDv7; call directly once signoz_list_alert_rules has resolved the id"
    },
    {
      "name": "signoz_list_dashboards",
      "description": "List paginated tenant-dashboard summaries and discover UUIDs, with an optional metadata filter DSL; use signoz_get_dashboard for panel and query definitions"
    },
    {
      "name": "signoz_get_dashboard",
      "description": "Get one known tenant dashboard's complete layout, variables, panels, and queries by id"
    },
    {
      "name": "signoz_create_dashboard",
      "description": "Create a custom multi-panel dashboard; use signoz_import_dashboard when a curated template fits and create_view for one Explorer query"
    },
    {
      "name": "signoz_update_dashboard",
      "description": "Fully replace a dashboard after fetching its definition, unwrapping the response's data object, and preserving every unrequested field"
    },
    {
      "name": "signoz_patch_dashboard",
      "description": "Apply an RFC 6902 JSON Patch to a dashboard by id (partial update without re-sending the whole dashboard)"
    },
    {
      "name": "signoz_delete_dashboard",
      "description": "Permanently delete a confirmed tenant dashboard by id; use signoz_list_dashboards to discover the UUID"
    },
    {
      "name": "signoz_import_dashboard",
      "description": "Create a tenant dashboard from a known curated SigNoz/dashboards template path; list templates first when the path is unknown"
    },
    {
      "name": "signoz_list_dashboard_templates",
      "description": "List the bundled curated template catalog and discover a path for signoz_import_dashboard; this is not the tenant-dashboard list"
    },
    {
      "name": "signoz_list_services",
      "description": "List paginated APM services with trace activity in a time window; use field-value discovery for arbitrary service.name values in logs"
    },
    {
      "name": "signoz_get_service_top_operations",
      "description": "Return one traced service's built-in operation table, ranked by p99 with p50/p95/p99, calls, and errors; use signoz_aggregate_traces for custom aggregation"
    },
    {
      "name": "signoz_list_views",
      "description": "List paginated saved Explorer views for traces, logs, metrics, or Cost Meter, with optional name/category filters"
    },
    {
      "name": "signoz_get_view",
      "description": "Get one saved Explorer view's complete definition by id; use before the full-replacement signoz_update_view"
    },
    {
      "name": "signoz_search_docs",
      "description": "Return ranked official-doc matches with URLs and snippets when no exact SigNoz documentation page is selected"
    },
    {
      "name": "signoz_fetch_doc",
      "description": "Fetch one known official SigNoz documentation page's full Markdown or a requested heading"
    },
    {
      "name": "signoz_create_view",
      "description": "Save one reusable Explorer query after reading both view authoring resources; use signoz_create_dashboard for a multi-widget dashboard"
    },
    {
      "name": "signoz_update_view",
      "description": "Fully replace a fetched saved view while preserving other fields; read its guides when changing sourcePage or compositeQuery, not for name/category/tags-only changes"
    },
    {
      "name": "signoz_delete_view",
      "description": "Permanently delete a confirmed saved Explorer view by id; use signoz_list_views to discover the UUID"
    },
    {
      "name": "signoz_aggregate_logs",
      "description": "Return aggregate log statistics and grouped or top-N breakdowns, not individual records; use signoz_search_logs for log rows and messages"
    },
    {
      "name": "signoz_search_logs",
      "description": "Return individual paginated log records; shortcut parameters need no guide, while custom filters with unfamiliar fields use the logs guide"
    },
    {
      "name": "signoz_aggregate_traces",
      "description": "Return custom aggregate span statistics, groups, or time series; use signoz_get_service_top_operations for one service's built-in p99-ranked operation table"
    },
    {
      "name": "signoz_search_traces",
      "description": "Return individual paginated span rows matching trace filters or discover trace IDs; use aggregate_traces for statistics and get_trace_details for a known trace"
    },
    {
      "name": "signoz_get_trace_details",
      "description": "For a known trace ID, return its spans, metadata, and hierarchy within a containing time window; use signoz_search_traces when the ID is unknown"
    },
    {
      "name": "signoz_execute_builder_query",
      "description": "Run Query Builder v5 requests that the dedicated log, trace, or metric tools cannot express, including multi-query requests, formulas, PromQL, and ClickHouse SQL; formulas use input limit 10000, result limit 100, and non-empty spec.order"
    },
    {
      "name": "signoz_list_notification_channels",
      "description": "List paginated notification-channel summaries for exact-name verification, duplicate checks, and ID discovery; use get for provider-specific settings"
    },
    {
      "name": "signoz_create_notification_channel",
      "description": "Create a uniquely named notification channel after listing existing names, then send a test notification"
    },
    {
      "name": "signoz_update_notification_channel",
      "description": "Fully replace a notification channel after fetching its complete configuration, then send a test notification"
    },
    {
      "name": "signoz_get_notification_channel",
      "description": "Get all provider-specific settings for one notification channel by ID"
    },
    {
      "name": "signoz_delete_notification_channel",
      "description": "Permanently delete a confirmed notification channel by ID; call directly once resolved, but note that it does not check alert-rule references"
    }
  ],
  "resources": [
    {
      "uri": "signoz://alert/examples",
      "name": "Alert Rule Examples",
      "description": "Read this after signoz://alert/instructions only when examples are still needed. Resolve illustrative direct/anomaly names with signoz_list_notification_channels; if none fits, offer signoz_create_notification_channel. Confirmed v2 policy routing may omit direct channels; anomaly cannot use policy routing.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://alert/instructions",
      "name": "Alert Rule Instructions",
      "description": "Read this before creating or updating an alert unless its current content was already read for the same prepared operation. It explains fields, rule types, queries, thresholds, evaluation, and when to reuse or call signoz_list_notification_channels. Read signoz://alert/examples only when examples are still needed.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-logs-example",
      "name": "ClickHouse Logs Examples",
      "description": "Read this after signoz://dashboard/clickhouse-schema-for-logs when composing a raw ClickHouse logs widget. It covers timestamp and attribute filters, resource CTEs, variables, timeseries/value shapes, and performance patterns.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-metrics-example",
      "name": "ClickHouse Metrics Examples",
      "description": "Read this after signoz://dashboard/clickhouse-schema-for-metrics when composing a raw ClickHouse metrics widget. It covers counter rates, error ratios, histogram quantiles, time-series tables, variables, and performance patterns.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-schema-for-logs",
      "name": "ClickHouse Logs Schema",
      "description": "Read this before writing ClickHouse SQL for a dashboard widget over SigNoz logs. It lists tables and columns from the schema bundled with this server. Also read signoz://dashboard/clickhouse-logs-example. If the live SigNoz instance rejects a table or column, follow that error because the bundled schema may lag.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-schema-for-metrics",
      "name": "ClickHouse Metrics Schema",
      "description": "Read this before writing ClickHouse SQL for a dashboard widget over SigNoz metrics. It lists tables and columns from the schema bundled with this server. Also read signoz://dashboard/clickhouse-metrics-example. If the live SigNoz instance rejects a table or column, follow that error because the bundled schema may lag.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-schema-for-traces",
      "name": "ClickHouse Traces Schema",
      "description": "Read this before writing ClickHouse SQL for a dashboard widget over SigNoz traces. It lists tables and columns from the schema bundled with this server. Also read signoz://dashboard/clickhouse-traces-example. If the live SigNoz instance rejects a table or column, follow that error because the bundled schema may lag.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/clickhouse-traces-example",
      "name": "ClickHouse Traces Examples",
      "description": "Read this after signoz://dashboard/clickhouse-schema-for-traces when composing a raw ClickHouse traces widget. It covers resource filters, timeseries/value/table result shapes, span events, latency analysis, and performance patterns.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/instructions",
      "name": "Dashboard Basic Instructions",
      "description": "Read this before creating or fully replacing a dashboard. It explains dashboard fields, metadata, variables, variable chaining, and layout. Also read signoz://dashboard/widgets-instructions for widget and query choices.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/query-builder-example",
      "name": "Query Builder Examples",
      "description": "Read this when composing a Query Builder dashboard widget. It covers signal-specific aggregations, filters, metric naming, grouped legends, functions, and examples; use the ClickHouse or PromQL resources instead for those query types.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/widgets-examples",
      "name": "Dashboard Widgets Examples",
      "description": "Read this after the dashboard and widget instructions when building panels. It provides one worked, server-verified v6 panel payload per panel type (timeseries, list, pie, table, value/number) to copy structurally. Verify field names in the target SigNoz workspace.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/widgets-instructions",
      "name": "Dashboard Widget Instructions",
      "description": "Read this when choosing or building dashboard widgets. It explains when to use each panel type, required layout and legend fields, and which detailed guide to read for each query type. Also read signoz://dashboard/instructions.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/list-filter-guide",
      "name": "Dashboard List Filter Guide",
      "description": "Read this to build the optional filter argument of signoz_list_dashboards. It documents the server-side metadata filter DSL: grammar (terms, AND/OR/NOT, free-text search), the filterable keys (name, description, created_by, created_at, updated_at, locked, and tag keys) with their operators and value formats, and worked examples.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/patch-instructions",
      "name": "Dashboard Patch Instructions",
      "description": "Read this before calling signoz_patch_dashboard. It gives worked RFC 6902 JSON Patch recipes with exact JSON Pointer paths for targeted edits (rename, add/edit/move/remove a panel, edit a query, variables, tags), including the two-op sequences the backend requires (adding a panel needs a panel op plus a grid-item op). For the panel/query/variable JSON to use as a patch value, also read signoz://dashboard/widgets-examples and signoz://dashboard/instructions.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://dashboard/examples",
      "name": "Dashboard Examples",
      "description": "Read this when assembling a complete dashboard (panels + layout) with signoz_create_dashboard, or for a worked metrics Query Builder panel. It provides whole server-verified v6 create payloads: a timeseries grouped by an attribute, the same with a dynamic variable used as a filter, a number/value panel, and a multi-panel dashboard. For single-panel shapes see signoz://dashboard/widgets-examples; for layout and variable rules see signoz://dashboard/instructions.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://docs/sitemap",
      "name": "SigNoz Docs Sitemap",
      "description": "Use this resource when an MCP client needs the indexed official SigNoz documentation catalog and page URLs. Use signoz_search_docs for topical discovery and signoz_fetch_doc for page content.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://logs/query-builder-guide",
      "name": "Logs Query Builder Guide",
      "description": "Read this before writing Query Builder v5 JSON for logs or filtering on unfamiliar log fields. It explains filter syntax, field discovery, body and JSON-path search, row and aggregate queries, stable pagination, limits, ordering, timestamps, and examples for rows, single values, and time series.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://metrics-aggregation-guide",
      "name": "Metrics Aggregation Guide",
      "description": "Read this before choosing aggregations for signoz_query_metrics or building metrics Query Builder JSON. It explains timeAggregation, spaceAggregation, and reduceTo by metric type; formulas and limits; how groupBy field context is inferred; top-N selection across the full window; step intervals; examples; and Cost Meter queries.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://promql/instructions",
      "name": "PromQL Instructions",
      "description": "Read this when composing a PromQL dashboard widget or promql_rule alert. It explains SigNoz's Prometheus 3.x quoted-selector form for dotted OTel metric names, resource labels, examples, and query checks; do not use it for Query Builder or ClickHouse SQL.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://traces/query-builder-guide",
      "name": "Traces Query Builder Guide",
      "description": "Read this before writing Query Builder v5 JSON for traces or filtering on unfamiliar trace fields. It explains filter syntax, field discovery, built-in span fields, row and aggregate queries, limits, ordering, timestamps, and examples for rows, single values, and time series.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://view/examples",
      "name": "Saved View Examples",
      "description": "Read this after signoz://view/instructions when composing a saved Explorer view. It provides complete Query Builder v5 payloads for traces, logs, metrics, and Cost Meter source pages.",
      "mimeType": "text/markdown"
    },
    {
      "uri": "signoz://view/instructions",
      "name": "Saved View Instructions",
      "description": "Read this before creating or updating a saved Explorer view. It explains view fields, sourcePage, Query Builder v5, Cost Meter views, and how to read a view before replacing it. It does not describe dashboards.",
      "mimeType": "text/markdown"
    }
  ],
  "compatibility": {
    "platforms": [
      "darwin",
      "linux",
      "win32"
    ]
  },
  "user_config": {
    "signoz_url": {
      "type": "string",
      "title": "SigNoz URL",
      "description": "URL to your SigNoz instance",
      "required": true,
      "sensitive": false
    },
    "signoz_api_key": {
      "type": "string",
      "title": "SigNoz API Key",
      "description": "API key for accessing SigNoz API",
      "required": true,
      "sensitive": true
    },
    "log_level": {
      "type": "string",
      "title": "Log Level",
      "description": "Logging level (debug, info, warn, error)",
      "required": false,
      "sensitive": false
    }
  },
  "keywords": [
    "signoz",
    "observability",
    "metrics",
    "traces",
    "logs",
    "dashboards",
    "alerts"
  ],
  "license": "Apache-2.0",
  "repository": {
    "type": "git",
    "url": "https://github.com/SigNoz/signoz-mcp-server"
  }
}