signoz-docs
Use this skill first whenever the user asks about SigNoz instrumentation, OpenTelemetry setup, querying, dashboards, alerts, troubleshooting, self-hosted deployment, API endpoints, auth headers, or where to find anything in SigNoz docs.
- Installs
- 116
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/signoz/agent-skills --skill signoz-docs- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads signoz-docs automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
SigNoz Docs
Use official signoz.io documentation and API references only. Ground every answer in fetched docs content and cite the canonical docs URL.
Access Docs
SigNoz docs support Accept: text/markdown. Fetch docs pages as markdown instead of scraping HTML.
Discover pages
Use the sitemap to search for candidate pages:
GET https://signoz.io/docs/sitemap.md
Fetch a page
Fetch any docs page as markdown by requesting it with:
GET https://signoz.io/docs/<path>/
Accept: text/markdown
For example, to fetch the logs overview page:
GET https://signoz.io/docs/logs-management/overview/
Accept: text/markdown
Workflow
- Identify the domain from the user's question: instrumentation, OpenTelemetry setup, querying, dashboards, alerts, troubleshooting, deployment, or API docs.
- Check the heuristics table below. If a heuristic matches, read that file before choosing docs pages.
- Search
sitemap.mdfor candidate pages that match the user's product area, environment, language, and task. - Rank the best 2-5 official pages by how directly they help the user complete the task.
- Fetch only the top page(s) as markdown with
Accept: text/markdown.- Fetch one page for narrow questions that map cleanly to a single setup guide, troubleshooting page, or API reference.
- Fetch multiple pages when the task clearly spans multiple needs, such as collection-method selection plus a language guide, setup plus troubleshooting, or overview plus exact API/auth details.
- Keep the fetch set small and purposeful. Do not fetch loosely related pages just because they share keywords.
- Answer from the fetched docs and cite canonical
https://signoz.io/docs/...URLs. - Handle ambiguity deliberately: if multiple pages are plausible, prefer the page that completes the task most directly and mention alternates only when they materially change the answer.
Ranking Hints
- Prefer setup, troubleshooting, or API-reference pages over overview pages when the user needs an action.
- Prefer pages that match the user's runtime, language, deployment environment, or SigNoz product area.
- For API questions, prefer the exact endpoint/auth/reference page over a general guide.
- Stay within official
signoz.iodocs pages when this skill applies.
Domain Heuristics
Read the matching heuristic file before fetching docs. Each file contains decision logic to route the user to the right guide.
| Topic | Trigger keywords | Heuristic file |
|---|---|---|
| Sending Logs | logs, log collection, logging, send logs | sending-logs.md |
FAQ
What does the signoz-docs skill do?
Use this skill first whenever the user asks about SigNoz instrumentation, OpenTelemetry setup, querying, dashboards, alerts, troubleshooting, self-hosted deployment, API endpoints, auth headers, or where to find anything in SigNoz docs.
How do I install signoz-docs?
Run npx skills add https://github.com/signoz/agent-skills --skill signoz-docs in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/signoz-docs/ (personal) or .claude/skills/signoz-docs/ (project).
Which AI agents can use signoz-docs?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is signoz-docs safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains signoz-docs?
It is published by signoz in signoz/agent-skills, and it is an official skill from the maker of the technology it covers. It has 116 recorded installs.
More from signoz/agent-skills
signoz-searching-docs
signoz/agent-skills
Look up information in SigNoz documentation. Make sure to use this skill whenever the user asks "how do I", "where in the docs", "what does the docs say about", "find docs for", or otherwise needs reference material on SigNoz instrumentation, OpenTelemetry setup, self-hosted deployment, API endpoints, auth headers, or troubleshooting steps, even if they don't say the word "docs" explicitly. Docs lookup only; for actions inside SigNoz, the agent will pick the matching signoz- action skill.
signoz-creating-dashboards
signoz/agent-skills
Create a new SigNoz dashboard from a natural-language intent: import a curated template (PostgreSQL, Redis, JVM, k8s, hostmetrics, APM, LLM, etc.) when one fits, or build a custom dashboard from scratch with metric / trace / log panels. Make sure to use this skill whenever the user says "create a dashboard for…", "set up monitoring for…", "build me a dashboard…", "I need observability for…", "import a dashboard template", or asks to track / visualize a service, database, cluster, or AI/LLM platform, even if they don't explicitly say "dashboard". Also use it when someone wants to "monitor", "watch", or "see metrics for" a technology and the natural answer is a dashboard.
signoz-generating-queries
signoz/agent-skills
Generate, write, or run an ad-hoc query against SigNoz observability data (metrics, logs, or traces) without wrapping it in a dashboard panel or alert. Make sure to use this skill whenever the user asks "show me error rates", "query logs for timeout errors", "what's the p99 latency for the cart service", "how many requests hit the payment endpoint", "find slow traces", "errors in the last hour", or otherwise asks an exploratory question that needs live observability data, even if they don't say "query" or "search" explicitly.
signoz-writing-clickhouse-queries
signoz/agent-skills
Write raw ClickHouse SQL for a SigNoz dashboard panel: timeseries, value, or table widgets that the builder UI cannot express (custom joins, window functions, regex extraction over log bodies, aggregations beyond builder syntax). Trigger when the user explicitly asks for a "ClickHouse query", a "raw SQL panel", a "custom SQL widget", or describes a SigNoz dashboard panel whose query needs SQL the builder cannot produce. Anchored to dashboard-panel SQL specifically. For ad-hoc data exploration that does not need to land in a panel, use signoz-generating-queries instead.
signoz-explaining-dashboards
signoz/agent-skills
Explain what an existing SigNoz dashboard shows in plain operational language: the panels, queries, variables, and what to watch for on each. Make sure to use this skill whenever the user asks "explain this dashboard", "what does my [X] dashboard show", "walk me through the panels", "what should I watch for on this dashboard", or "help me understand this dashboard", or otherwise asks for an interpretation of a dashboard's contents, even if they don't say "explain" explicitly. Also use it when someone is onboarding to a service and wants to understand what its existing observability looks like.
signoz-modifying-dashboards
signoz/agent-skills
Modify an existing SigNoz dashboard: add or remove panels, edit a panel's query, threshold, or unit, rename the dashboard, change a panel type (graph ↔ table ↔ value), rearrange the layout, add or edit variables, or update tags. Make sure to use this skill whenever the user says "add a panel to my dashboard", "change the query on this panel", "remove the latency widget", "rename my dashboard", "update the filters", "rearrange the layout", "add a variable", "change panel type from graph to table", or otherwise asks to change something on a dashboard that already exists, even if they don't say "modify" or "edit" explicitly.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.