Skip to main content
Glama
srwlli

Documentation Generator MCP Server

by srwlli
documentation-schema.json4.82 kB
{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Documentation Inventory Manifest Schema", "description": "Schema for validating documentation inventory manifests generated by documentation_inventory tool", "type": "object", "required": [ "project_name", "project_path", "generated_at", "documentation_files", "source_components_count", "metrics" ], "properties": { "project_name": { "type": "string", "description": "Name of the project", "minLength": 1 }, "project_path": { "type": "string", "description": "Absolute path to project directory", "minLength": 1 }, "generated_at": { "type": "string", "description": "ISO 8601 timestamp of manifest generation", "format": "date-time" }, "documentation_files": { "type": "array", "description": "List of discovered documentation files", "items": { "type": "object", "required": [ "file_path", "format" ], "properties": { "file_path": { "type": "string", "description": "Relative path to documentation file" }, "format": { "type": "string", "description": "Documentation format", "enum": [ "markdown", "restructured_text", "asciidoc", "html", "orgmode", "plaintext", "unknown" ] }, "size_bytes": { "type": "integer", "description": "File size in bytes", "minimum": 0 }, "sections_count": { "type": "integer", "description": "Number of sections/headings", "minimum": 0 }, "code_examples_count": { "type": "integer", "description": "Number of code examples/blocks", "minimum": 0 }, "external_links_count": { "type": "integer", "description": "Number of external hyperlinks", "minimum": 0 }, "internal_links_count": { "type": "integer", "description": "Number of internal hyperlinks", "minimum": 0 }, "last_modified": { "type": "string", "description": "ISO 8601 timestamp of last modification", "format": "date-time" }, "freshness_score": { "type": "number", "description": "Freshness score based on last modified date (0-100)", "minimum": 0, "maximum": 100 }, "completeness_score": { "type": "number", "description": "Completeness score based on sections and examples (0-100)", "minimum": 0, "maximum": 100 }, "error": { "type": "string", "description": "Error message if file could not be analyzed" } }, "additionalProperties": false } }, "source_components_count": { "type": "integer", "description": "Total number of source code components", "minimum": 0 }, "metrics": { "type": "object", "description": "Aggregated documentation metrics", "required": [ "total_documentation_files", "coverage_score", "freshness_score", "completeness_score", "quality_score", "source_components" ], "properties": { "total_documentation_files": { "type": "integer", "description": "Total number of documentation files", "minimum": 0 }, "coverage_score": { "type": "number", "description": "Documentation coverage percentage (0-100)", "minimum": 0, "maximum": 100 }, "freshness_score": { "type": "number", "description": "Average freshness score of all docs (0-100)", "minimum": 0, "maximum": 100 }, "completeness_score": { "type": "number", "description": "Average completeness score of all docs (0-100)", "minimum": 0, "maximum": 100 }, "quality_score": { "type": "number", "description": "Overall quality score weighted by coverage, freshness, completeness (0-100)", "minimum": 0, "maximum": 100 }, "source_components": { "type": "integer", "description": "Number of source code components found", "minimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/srwlli/docs-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server