mcpField
W
write-guide

write-guide

github.com/runpodAgent 工作流47839 次安装2 天前更新
代码仓库

关于 write-guide

Runpod 官方 Agent 技能集合，面向使用 Claude Code、Codex 和 Gemini CLI 的编码工作流，提供 Runpod 操作指导及托管 MCP 服务入口。

主要功能

  1. 01面向 Runpod 的 Agent 技能
  2. 02面向 Claude Code、Codex 和 Gemini CLI
  3. 03提供托管 Runpod MCP 服务

适用场景

  1. 01指导编码 Agent 操作 Runpod
  2. 02通过 MCP 管理云端资源

MCP 相关

该技能集合包含托管的 Runpod MCP 服务，用于管理 Pods、Serverless 端点、模板和卷。

安装

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

$npx skills add https://github.com/runpod/runpod-plugins-official --skill write-guide

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

详细介绍

编写与概念图保持一致的指南

此仓库包含两类必须保持一致的内容：

  • 概念（plugins/runpod/skills/runpod-usage/concepts/*.yaml）以规则的形式记录精确事实，每条规则都引用公开来源。它们是事实依据。
  • 指南（每个 SKILL.md、reference/*.md 和黄金路径）用于解释、教学和演示。它们是操作方法的依据。

指南陈述的事实必须有概念规则支持，并链接到涵盖的概念。每个概念至少由一份指南涵盖。pnpm check:guides 会检查这两类链接。

编写或修改指南

  1. 编写前先找出涉及的概念（在 ontology/tools/ 中运行以下命令）：

    pnpm build:sqlite
pnpm query tree "<concept>"      # the concept, its children and the guides that cover them
pnpm query search "<question>"   # the rules that answer a question
pnpm query concept "<name>"      # every rule on one concept, with evidence

  2. 依据规则编写。 每条事实性陈述（限制、默认值、状态、某项操作的作用、存在的内容）都必须与规则一致。用自己的话解释，并补充操作方法：命令、顺序、注意事项和验证方式。

    • 如果指南需要某条规则尚未涵盖的事实，先使用 add-concept 技能添加规则，并引用规范、公开文档或实时探测作为依据，然后再编写指南。
    • 如果规则有误或已过时，请在同一次修改中修正规则及其证据。
    • 切勿让指南和规则互相矛盾。如果发现不一致，以公开来源为准，决定修改哪一方。

  3. 声明链接。

    指南位置示例
    SKILL.mdfrontmatter 中的 metadata.conceptsconcepts: [pod, network-volume]
    参考文档文件顶部 frontmatter 中的 concepts: 行---
    concepts: [runpod-secret]
    ---
    黄金路径frontmatter 中的 lanes、mcp 和 concepts参见 plugins/runpod/skills/runpod/golden-paths/README.md

    列出指南实际解释或使用的概念，而不是提及的每个概念。pnpm build:bundle --suggest 会列出各黄金路径命名的概念，供你参考。 如果规则已引用某篇参考文档作为证据，系统会自动为其添加链接；但如果该文档涵盖的概念多于引用它的规则，仍请列出这些概念。

  4. 当某篇文档是解释某个概念的主要文档时，链接到规则。在文档末尾添加简短的“精确规则”部分，并为每个概念文件添加 Markdown 链接（在参考文档中，目标路径为 ../concepts/<id>.yaml）。

  5. 配置入口。 新增参考文档时，在所属技能的 SKILL.md 表格中添加一行。新增黄金路径时，在路由器表格和 golden-paths/README.md 中添加相应行。

添加或修改概念后

  1. 如果新增概念没有对应指南，pnpm check:guides 会失败。请按照上述步骤扩展现有文档或编写新文档。

  2. 找出已经涵盖该概念的指南，并检查它们是否仍与规则一致：

    pnpm query tree "<concept>"                    # guides linked to it
grep -rln "<name or alias>" ../../plugins/     # guides that mention it without a link

  3. 当某条规则引用技能文件作为证据，而你修改了该文件时，请重新阅读规则： grep -rn "<path>" ../../plugins/runpod/skills/runpod-usage/concepts/。

风格

遵循 plugins/runpod/skills/runpod-usage/concepts/README.md →“写作风格”，以及 AGENTS.md 中的仓库规范：使用一般现在时和朴素语言，使用“Runpod”，代码标识符放在反引号中，不使用“currently”或“not yet”，并优先使用肯定式表述，而不是声称某项功能缺失（缺失能力的说法需要以规范或文档为依据，CLI 缺失声明则由 hooks/check_cli_absence_claims.py 检查）。

检查

cd ontology/tools
pnpm format && pnpm validate --strict && pnpm check:guides && pnpm test
cd ../.. && python3 hooks/check_links.py && python3 hooks/check_runpod_branding.py

check:guides 必须报告零错误，且构建输出中的“有指南的概念”数量必须始终等于概念总数。

评论

支持 Markdown