ultra-docs

Generate structured, step-by-step documentation for tasks like API endpoints or setup instructions, with customizable formats, AI providers, and options to include code examples or type information.

Instructions

Generate comprehensive documentation with step-by-step workflow

Input Schema

Name	Required	Description	Default
`files`	No	File paths to document (optional)
`findings`	No	Accumulated documentation content
`format`	No	Documentation format	markdown
`includeExamples`	No	Include code examples in documentation
`includeTypes`	No	Include type information for TypeScript/Flow
`model`	No	Specific model to use
`nextStepRequired`	No	Whether another step is needed
`provider`	No	AI provider to use
`stepNumber`	No	Current step in the documentation workflow
`task`	Yes	What to document (e.g., "API endpoints", "setup instructions")
`totalSteps`	No	Estimated total steps needed

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "files": {
      "description": "File paths to document (optional)",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "findings": {
      "default": "",
      "description": "Accumulated documentation content",
      "type": "string"
    },
    "format": {
      "default": "markdown",
      "description": "Documentation format",
      "enum": [
        "markdown",
        "comments",
        "api-docs",
        "readme",
        "jsdoc"
      ],
      "type": "string"
    },
    "includeExamples": {
      "default": true,
      "description": "Include code examples in documentation",
      "type": "boolean"
    },
    "includeTypes": {
      "default": true,
      "description": "Include type information for TypeScript/Flow",
      "type": "boolean"
    },
    "model": {
      "description": "Specific model to use",
      "type": "string"
    },
    "nextStepRequired": {
      "default": true,
      "description": "Whether another step is needed",
      "type": "boolean"
    },
    "provider": {
      "description": "AI provider to use",
      "enum": [
        "openai",
        "gemini",
        "azure",
        "grok"
      ],
      "type": "string"
    },
    "stepNumber": {
      "default": 1,
      "description": "Current step in the documentation workflow",
      "minimum": 1,
      "type": "number"
    },
    "task": {
      "description": "What to document (e.g., \"API endpoints\", \"setup instructions\")",
      "type": "string"
    },
    "totalSteps": {
      "default": 2,
      "description": "Estimated total steps needed",
      "minimum": 1,
      "type": "number"
    }
  },
  "required": [
    "task"
  ],
  "type": "object"
}

Ultra MCP

ultra-docs

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Ultra MCP

Related Tools

MCP directory API