Skip to main content
Glama
Sign In
Documentation MCP Server

Documentation MCP Server

by ThaLoc0one
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

docs_generate_openapi

Analyze PHP project routes and generate OpenAPI 3.0 specification with middleware, parameters, and security schemes. Convert controller routes to API documentation automatically.

Instructions

Generate OpenAPI 3.0 specification from analyzed PHP routes with middleware, parameters, and security schemes. Automatically converts controller routes to API documentation.

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": {
      "projectPath": "<projectPath>"
    },
    "name": "docs_generate_openapi"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectPathYesPath to the PHP project directory to analyze
outputPathNoOutput path for OpenAPI spec file (default: ./openapi.json)
formatNoOutput formatjson
titleNoAPI title (default: 'API Documentation')
versionNoAPI version (default: '1.0.0')
serverUrlNoAPI server URL (e.g., 'https://api.example.com')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It mentions generation and conversion, which implies a write operation, but does not disclose side effects (e.g., overwriting output files) or permissions needed. The purpose is clear but behavioral details are lacking.

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?

The description is two sentences, front-loaded with the main purpose, and contains no redundant information. Every word adds value.

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 the absence of an output schema, the description explains the output (OpenAPI 3.0 specification) and what it includes (routes, middleware, parameters, security schemes). It is sufficiently complete for a generation tool.

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?

Schema description coverage is 100%, so the schema already documents all parameters adequately. The tool description adds no extra parameter-level information beyond the schema, so baseline 3 applies.

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 the verb 'Generate' and the resource 'OpenAPI 3.0 specification from analyzed PHP routes'. It differentiates itself from siblings by specifying the input type (PHP routes) and including details like middleware, parameters, and security schemes.

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 usage for generating OpenAPI specs from PHP routes, but does not explicitly state when to use this tool versus alternatives like docs_generate_api or docs_export_pdf. No when-not-to-use or comparative guidance is provided.

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