AgentScope 文档生成器

安装指南

1. ClawHub CLI 从源直接安装技能的最快方式。
   npx clawhub@latest install agentscope-doc-generator
2. 手动安装 将技能文件夹复制到以下位置之一
   全局模式
   ~/.openclaw/skills/
   工作区
   /skills/
   优先级：工作区 > 本地 > 内置
3. 提示词安装 将此提示词复制到 OpenClaw 即可自动安装。
   请帮我使用 Clawhub 安装 agentscope-doc-generator。如果尚未安装 Clawhub，请先安装（npm i -g clawhub）。
   更倾向于下载？
   获取包含原生技能文件的ZIP压缩包。
   下载技能 (.zip)

什么是

AgentScope 文档生成器是一款 Openclaw Skills 实用工具，可将 AgentScope 2.0 项目结构、配置和工作流定义转换为实用的文档成果。它帮助开发者搭建 README 文件框架、总结代理能力并记录流水线，无需手动检查每个源文件。
该生成器完全基于本地项目文件运行，包括代理配置、技能定义和 Python 流水线代码。它不会提取或输出机密信息，但发布前仍需审核生成的内容。

应用场景

为 AgentScope 技能和插件创建 README 框架。
agent.json
config.json
文件生成代理能力摘要。
run.py
或相关项目代码记录流水线和工作流定义。
根据现有 AgentScope 配置生成使用示例。
统一 AgentScope 2.0 项目的文档格式。
在项目没有 README 或能力指南时，快速搭建项目文档。
使用 Openclaw Skills 自动准备文档，同时将源数据保留在本地。

工作原理

确定包含配置、技能或流水线文件的 AgentScope 项目目录。
检查受支持的来源，例如 agent.json、config.json、skills/*/SKILL.md、run.py 和流水线定义。
解析可用的项目结构和配置数据。
生成文档成果，包括 README 模板、代理能力表和基于配置的使用示例。
将生成的文档写入通过 --output 指定的目录。
检查生成内容的准确性、完整性以及是否适合发布。
记录技能时，可通过显式传入 --project 并验证 SKILL.md 的 YAML 前置元数据来排查检测问题。

配置指南

确保已安装 Python 3，且可通过 python3 使用。
获取此技能并进入其文件夹。
确认目标 AgentScope 项目包含受支持的源文件，例如 agent.json、config.json、skills//SKILL.md 或 run.py。
使用明确的项目路径和输出路径运行生成器：
python3 scripts/generate_docs.py --project /path/to/agentscope/project --output /tmp/docs
发布前检查输出目录中生成的文件。
此技能不需要环境变量、API 密钥或外部服务凭据。其 Openclaw Skills 元数据声明 python3 是唯一必需的可执行程序。
AgentScope 文档生成器 数据架构与分类体系
生成器围绕本地 AgentScope 项目源组织文档，并将结果写入所选输出目录。
来源 文档用途
agent.json 代理配置和能力信息
config.json 代理文档的备用配置来源
skills//SKILL.md 技能或插件元数据及说明内容
run.py Python 入口点和流水线相关实现
流水线定义 工作流结构和执行文档
生成的内容包括：
技能和插件的 README 模板。
代理能力表。
根据配置生成的使用示例。
根据工作流定义编写的流水线文档。
生成器仅读取本地文件。其设计目标是不提取或输出机密信息，但仍应审核生成的文档，避免意外泄露并确保技术准确性。

高级特性

支持多种 AgentScope 文档目标，包括代理、流水线、技能和插件。
创建能力表，让代理功能一目了然。
根据现有项目配置生成使用示例。
agent.json
config.json
两种项目布局。
skills/*/SKILL.md
中的嵌套技能文档。
记录工作流定义和 Python 流水线入口点。
支持明确指定项目路径和输出路径，以便重复执行 CLI 自动化任务。
仅使用本地项目数据，无需环境变量或外部凭据。
适用于在发布前审核生成文档的 Openclaw Skills 工作流。

name: agentscope-doc-generator description: Generate documentation for AgentScope 2.0 agents, pipelines, and skills from code and config files. Use this when the user wants README scaffolding, agent capability docs, or project documentation from existing AgentScope code. version: 0.1.0