Skip to main content
Glama
Sign In
patchwork-os

patchwork-os

by Oolab-labs
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

generateAPIDocumentation

Read-only

Generate API documentation from TypeScript/JavaScript source files by automatically extracting exported functions, classes, interfaces, and JSDoc comments. Choose between markdown or JSON output.

Instructions

Generate API docs (markdown/JSON) for TS/JS exported symbols. Extracts fns, classes, interfaces, JSDoc.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "files": "<files>"
    },
    "name": "generateAPIDocumentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
filesYesRelative file paths to document (required)
formatNoOutput format (default: markdown)
includePrivateNoInclude non-exported symbols (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare readOnlyHint=true, and the description confirms it extracts symbol types without mutation, adding context about JSDoc extraction. No contradictions, but could elaborate on JSDoc handling and import traversal.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, 12 words, front-loaded with the core purpose. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 3 parameters fully described in schema and no output schema, the description provides sufficient context about purpose and extracted symbols. Missing explicit output format details (though implied by 'markdown/JSON').

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema covers 100% of parameters with descriptions. The description adds minimal extra context (e.g., TS/JS focus) but does not significantly enhance understanding beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it generates API docs in markdown/JSON for TS/JS exported symbols, extracting functions, classes, interfaces, and JSDoc. This distinguishes it from sibling tools like generateTests, getHover, etc.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use it (when API documentation is needed) but does not explicitly state when not to use it or mention alternative tools like getHover for individual symbol documentation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools