mcpField
S
signoz-docs

signoz-docs

github.com/signoz云与 DevOps19116 次安装5 天前更新
代码仓库

关于 signoz-docs

signoz-docs 是一项基于 SigNoz 官方文档和 API 参考资料回答问题的技能。它指导页面搜索、筛选与引用，并要求答案以获取的文档内容为依据。

主要功能

  1. 01搜索文档站点地图
  2. 02以 Markdown 获取页面
  3. 03筛选相关官方页面
  4. 04引用规范文档 URL

适用场景

  1. 01查找 SigNoz 配置指南
  2. 02解答查询或告警相关问题
  3. 03查阅 SigNoz API 参考资料

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/signoz/agent-skills --skill signoz-docs

安装后在 Claude Code 中输入/signoz-docs确认已加载。

附带文件README.mdheuristics/sending-logs.md

详细介绍

SigNoz 文档

仅使用官方 signoz.io 文档和 API 参考。所有回答都必须以获取的文档内容为依据，并引用规范文档 URL。

访问文档

SigNoz 文档支持 Accept: text/markdown。请以 Markdown 格式获取文档页面，而不要抓取 HTML。

查找页面

使用站点地图搜索候选页面：

GET https://signoz.io/docs/sitemap.md
获取页面

通过以下方式请求任何文档页面，即可将其作为 Markdown 获取：

GET https://signoz.io/docs/<path>/
Accept: text/markdown

例如，获取日志概览页面：

GET https://signoz.io/docs/logs-management/overview/
Accept: text/markdown

工作流

  1. 识别问题领域：根据用户的问题判断领域，如插桩、OpenTelemetry 配置、查询、仪表板、告警、故障排除、部署或 API 文档。
  2. 查看下方的启发式规则表。如果符合某项规则，请先阅读对应文件，再选择文档页面。
  3. 搜索 sitemap.md，查找候选页面，使其与用户的产品领域、环境、语言和任务相匹配。
  4. 按相关程度排列最合适的 2-5 个官方页面，优先选择最能直接帮助用户完成任务的页面。
  5. 仅以 Accept: text/markdown 格式获取排名靠前的页面。
    • 对于能明确对应到单个配置指南、故障排除页面或 API 参考的具体问题，获取 一个页面。
    • 如果任务明显涉及多个需求，例如选择采集方法并查阅语言指南、配置并排查问题，或概览并查阅具体 API/身份验证详情，则获取 多个页面。
    • 获取的页面应少而精、目标明确。不要仅因关键词相同就获取关联较弱的页面。
  6. 依据获取的文档作答，并引用规范的 https://signoz.io/docs/... URL。
  7. 审慎处理歧义：如果有多个可能的页面，优先选择最能直接完成任务的页面；只有当其他页面会实质性改变答案时，才提及备选页面。

排序提示

  • 用户需要采取行动时，优先选择配置、故障排除或 API 参考页面，而非概览页面。
  • 优先选择与用户的运行时、语言、部署环境或 SigNoz 产品领域相匹配的页面。
  • 对于 API 问题，优先选择对应的具体端点、身份验证或参考页面，而非通用指南。
  • 适用此技能时，仅使用 signoz.io 官方文档页面。

领域启发式规则

获取文档前，先阅读匹配的启发式规则文件。每个文件都包含用于将用户引导至正确指南的决策逻辑。

主题触发关键词启发式规则文件
发送日志logs、log collection、logging、send logssending-logs.md

评论

支持 Markdown