Skip to content
TrustedSkillsbeta
Back to all skills

Generate Agent Docs

Checked
jburlison·vlatest·agents

Automatically creates comprehensive documentation for your agent's functionality, inputs, outputs, and usage based on code and prompts.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add jburlison/metaprompts --skill generate-agent-docs -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

jburlison

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned jburlison/metaprompts at 50c14388d4.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
50c14388d4
Manifest
.github/skills/generate-agent-docs/SKILL.md
Scanned
1 file, 257 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill generates documentation for AI agents. It can produce structured text suitable for a knowledge base, API reference, or user guide, based on provided information about an agent's capabilities and intended use. The generated documents are designed to be clear, concise, and easily understandable by both technical and non-technical audiences. This helps in onboarding new users and maintaining consistent documentation as agents evolve.

When to use it

  • Onboarding New Agents: Quickly create initial documentation for a newly developed AI agent before widespread deployment.
  • Updating Existing Documentation: Efficiently update existing agent documentation when features or functionality change.
  • Creating API References: Generate comprehensive API references from agent function descriptions and parameters.
  • Building User Guides: Produce user-friendly guides explaining how to interact with and utilize specific AI agents.

Key capabilities

  • Generates structured text documents.
  • Suitable for knowledge bases, API references, and user guides.
  • Creates clear and concise documentation.
  • Supports both technical and non-technical audiences.

Example prompts

  • "Generate agent documentation for an AI assistant that summarizes news articles."
  • "Create a user guide explaining how to use the 'image_recognition' function in my AI agent."
  • “Write API reference documentation for the ‘send_email’ function, including parameters and return values.”

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and completeness of the input information provided about the agent. Ensure you have a good understanding of the agent's functionality before using this skill.