signoz-mcp-setup
Initialize or repair SigNoz MCP server configuration for Claude Code, Codex, Cursor, VS Code/GitHub Copilot, Claude Desktop, Gemini CLI, Devin CLI, Grok Build, Windsurf, Zed, Antigravity CLI, OpenCode, or another MCP client. Use this skill before any SigNoz docs, query, dashboard, alert, or view workflow when `signoz_*` tools are unavailable, or when the user says "setup SigNoz MCP", "configure SigNoz plugin", "wrong region", "change SigNoz region", "MCP auth failed", or asks to connect SigNoz Cloud or a self-hosted MCP endpoint, even if they do not mention the plugin.
SigNoz · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add SigNoz/agent-skills --skill signoz-mcp-setup技能说明
name: signoz-mcp-setup
description: >
Initialize or repair SigNoz MCP server configuration for Agent Plugins v1,
Claude Code, Codex, Cursor, VS Code/GitHub Copilot, Claude Desktop, Gemini
CLI, Devin CLI, Grok Build, Windsurf, Zed, Antigravity CLI, OpenCode, or
another MCP client. Use this skill before any SigNoz docs, query, dashboard,
alert, or view workflow when
signoz_* tools are unavailable, or when the user says "setup SigNoz
MCP", "configure SigNoz plugin", "wrong region", "change SigNoz region",
"MCP auth failed", or asks to connect SigNoz Cloud or a self-hosted MCP
endpoint, even if they do not mention the plugin.
argument-hint: <client, SigNoz Cloud region, MCP URL, or self-hosted /mcp URL>
SigNoz MCP Setup
Initialize or repair the SigNoz MCP server registration shipped with this
plugin. The target state is one working signoz MCP server. Do not create a
duplicate server unless the user explicitly asks for a separate configuration.
Shared reference
Read references/mcp-settings.md before checking state, mapping user input, or editing registration files. It contains the server-state check, registration file locations, editing rules, and region mapping used by this procedure.
Read references/client-configs.md for a portable Agent Plugins v1 install, when the user names a client other than the bundled Claude Code or Cursor plugin path, when a native client config already exists, or when self-hosted stdio/local-binary setup is requested.
Configuration procedure
Step 1: Identify the client
Determine this before checking state: it decides where state is allowed to be checked from.
Use the client named in $ARGUMENTS or the user's latest message. If no
client is named, infer it only when the active environment is obvious (which
agent CLI or editor is running this skill, not just what files happen to exist
on disk):
Classify the install from the format the active client loaded, not from other
files that happen to coexist in the plugin root. An Agent Plugins v1 install
uses the portable mcp.json when its root plugin.json declares the canonical
Agent Plugins schema, even if the same root contains registration files for
Claude Code, Cursor, or Grok Build. Use a client-specific registration
file only when that client loaded the corresponding compatibility package.
- Portable Agent Plugins v1 install, including a VS Code or Codex installation
whose root manifest declares the Agent Plugins schema: use the standard
mcp.jsonin the installed plugin root. - Claude Code compatibility-package install: use the persisted plugin option referenced by its bundled registration file. Cursor compatibility-package install: use its bundled registration file.
- Grok Build: use the Grok Build CLI recipe in
client-configs.md. It ships a bundled registration file, but its endpoint is configured through[mcp_servers.signoz], not by editing that file. - VS Code / GitHub Copilot native MCP setup: use the native recipe only when no
Agent Plugins v1 install is active, the user explicitly requests native
config, or the endpoint is not eligible for portable
mcp.json. - Claude Desktop, Gemini CLI, Devin CLI, Windsurf, Zed, Antigravity CLI, or
OpenCode: use the matching native client recipe in
client-configs.md. - Unknown or unsupported client: use the generic HTTP MCP recipe and point the user to the SigNoz MCP Server docs for their client's exact config surface.
If you need to edit a native client config and the client is still ambiguous, ask which client they want to configure.
Step 2: Check state
Silently determine the SigNoz MCP server state using the reference flow, scoped to the client identified in Step 1:
Probe with signoz_list_services(timeRange: "1h", limit: 1). Do not use docs
tools (signoz_search_docs or signoz_fetch_doc) for this check.
- For Codex, check the effective
signozentry withcodex mcp get signozorcodex mcp listbefore consulting the plugin-rootmcp.json; a native entry of the same name has higher precedence and may intentionally be the active fallback. For other Agent Plugins v1 clients, and for bundled Claude Code or Cursor installs, use the reference flow's client-specific fallback. - For Grok Build, read
[mcp_servers.signoz]from Grok's config scopes (or rungrok mcp list) instead. Its bundled.signoz_grok_mcp.jsonships a working default and is overridden by config, so it never reports the live state. - For every other client, including native VS Code setup and Devin CLI, do not
read or search for the plugin-root
mcp.json,.signoz_claude_mcp.json, or.signoz_cursor_mcp.json. Those are bundled files for a different plugin distribution and are irrelevant here even if a file-search tool happens to find them (for example when this skill is linked from a local checkout of theagent-skillssource repo itself). This does not exclude native files such as.vscode/mcp.jsonor.cursor/mcp.json; check the identified client's own native config location perclient-configs.md.
State outcomes:
- working:
signoz_list_servicessucceeded; continue with the user's original SigNoz request. - not-setup: run Step 3.
- configured-but-not-working: if the user provided a new region or MCP URL, run Step 3. Otherwise tell them the SigNoz MCP server is configured but not connected, then ask for the SigNoz Cloud region or MCP URL to repair it. If they believe the endpoint is already correct, tell them to complete the client authentication step in Step 5.
Do not fall back to raw HTTP calls for SigNoz data when MCP is unavailable. The MCP server is the supported API surface for this plugin's live SigNoz workflows.
The workflow skills assume the current SigNoz MCP server contract. If a SigNoz tool reports schema or parameter errors that contradict the skill instructions, repai
阅读完整来源 ↗