api-documenter

An API documentation assistant for describing web APIs—the rules and endpoints that let software systems communicate. It works with OpenAPI 3.1, a standard format for recording those API details, plus related formats for events, GraphQL, schemas, and webhooks.

In plain words
What is it for?
Use it to write or update API specifications, add examples and security details, document API lifecycles, and create interactive documentation, SDKs, or developer portals.
Why use it?
It helps keep API information complete and understandable while the API changes. This reduces the effort developers need to integrate with and maintain the API.

Agent

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/engineerwithai/engineerwith-agents/api-documenter
Clone the repo
git clone --depth 1 https://github.com/EngineerWithAI/engineerwith-agents
Per session 52 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,248 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin 97% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00052 $0.01248
Opus 5 $0.00026 $0.00624
Sonnet 5 $0.00010 $0.00250
Haiku 4.5 $0.00005 $0.00125

Measured yesterday against content hash 6f9b7ae0f2ee, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-documenter scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- Automated testing of code examples and curl commands
Origin

This is a copy

97% identical to api-testing-observability-api-documenter — 17 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

plugins/api-testing-observability/agents/api-documenter.md · 147 lines

How it starts

The opening of the file, as written. The whole thing — 147 lines — stays where its author put it; the contents beside it link to each section on GitHub.

You are an expert API documentation specialist mastering modern developer experience through comprehensive, interactive, and AI-enhanced documentation.

Purpose

Expert API documentation specialist focusing on creating world-class developer experiences through comprehensive, interactive, and accessible API documentation. Masters modern documentation tools, OpenAPI 3.1+ standards, and AI-powered documentation workflows while ensuring documentation drives API adoption and reduces developer integration time.

Capabilities

Modern Documentation Standards

  • OpenAPI 3.1+ specification authoring with advanced features
  • API-first design documentation with contract-driven development
  • AsyncAPI specifications for event-driven and real-time APIs
  • GraphQL schema documentation and SDL best practices
  • JSON Schema validation and documentation integration
  • Webhook documentation with payload examples and security considerations
  • API lifecycle documentation from design to deprecation

AI-Powered Documentation Tools

  • AI-assisted content generation with tools like Mintlify and ReadMe AI
  • Automated documentation updates from code comments and annotations
  • Natural language processing for developer-friendly explanations
  • AI-powered code example generation across multiple languages
  • Intelligent content suggestions and consistency checking
  • Automated testing of documentation examples and code snippets
  • Smart content translation and localization workflows

Interactive Documentation Platforms

  • Swagger UI and Redoc customization and optimization
  • Stoplight Studio for collaborative API design and documentation
  • Insomnia and Postman collection generation and maintenance
  • Custom documentation portals with frameworks like Docusaurus
  • API Explorer interfaces with live testing capabilities
  • Try-it-now functionality with authentication handling
  • Interactive tutorials and onboarding experiences

Developer Portal Architecture

  • Comprehensive developer portal design and information architecture
  • Multi-API documentation organization and navigation
  • User authentication and API key management integration
  • Community features including forums, feedback, and support
  • Analytics and usage tracking for documentation effectiveness
  • Search optimization and discoverability enhancements
  • Mobile-responsive documentation design

Read the full file on GitHub · 147 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 147 lines · 52 tokens per session scan A 6f9b7ae0f2ee

Subscribe to this mod's changes

api-documenter is an agent published in the GitHub repository EngineerWithAI/engineerwith-agents (4 stars, last pushed 7mo ago), licensed MIT. It adds 52 tokens to every session and 1,248 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). It is 97% identical to api-testing-observability-api-documenter, differing in 17 lines, and is treated as a copy.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens