Back to Help

Core Features

Understand the powerful capabilities that keep your docs in sync.

The Gardener

The Gardener is DocuAI's core automation engine. It watches every push and pull request in your activated repositories. When code changes are detected that affect documented features, The Gardener automatically creates a Pull Request with updated documentation.

  • Automatic Detection: Scans code diffs for changes to public APIs, functions, and configurations.
  • Smart Updates: Generates documentation updates that match your existing style.
  • Human Review: You always review and approve changes before they're merged.

Gap Detection

Gap Detection analyzes your entire codebase to identify features, APIs, or modules that are missing documentation. It prioritizes gaps by usage and importance.

  • Full Codebase Scan: Recursively analyzes all files to map code to docs.
  • Priority Ranking: Surfaces the most critical undocumented areas first.
  • Actionable Insights: Dashboard shows gaps you can address immediately.

The Inbox

The Inbox is your intelligence layer. It aggregates signals from user feedback submitted on your docs, as well as GitHub Issues that mention documentation problems. This gives you a unified view of where your docs are failing users.

  • User Feedback: Visitors can submit feedback directly from your hosted docs.
  • GitHub Issue Sync: Automatically links issues to relevant doc pages.
  • Prioritized Queue: See the most impactful signals at the top.

MCP Integration

DocuAI provides an MCP (Model Context Protocol) Server that allows AI-powered IDEs like Cursor, Windsurf, or Claude Desktop to query your documentation directly. This ensures the AI always has accurate, up-to-date context about your codebase.

How to Set Up

1Get an API Key

Go to your Dashboard, open the Settings tab, and generate a new API Key. Copy it immediately.

2Configure your IDE

Add a new MCP Server in your IDE settings (e.g., in Cursor or Claude Desktop config).

Add this to your IDE's MCP configuration file (typically claudemirror.json or similar):

{
  "mcpServers": {
    "DocuAI": {
      "type": "sse",
      "url": "https://www.docuai.co/api/mcp",
      "headers": {
        "x-api-key": "YOUR_API_KEY"
      }
    }
  }
}
3What to Expect

Once connected, you can ask your AI assistant questions like "How do I use the Auth module?". The AI will query DocuAI's index and retrieve the most relevant documentation snippets to answer accurately.