• HIERARCHY
  • CONTENT
  • GAPS
  • HUMAN

How to audit documentation structure with your AI

Connect ReadMe to your AI client to scan your entire documentation tree. Once connected, your agent can map out categories and find specific pages or dead ends.

Ask AI about this page

Short answer

How can I audit my documentation structure with AI?

Your AI uses the ReadMe MCP to pull your category lists and page hierarchies. It then identifies gaps, broken links, or deprecated content by comparing the actual structure against your requirements. You get a clear map of what exists and what needs fixing.

Where every issue lands.

Audit outcomes

The AI organizes its findings into these specific areas.

HIERARCHY

Full structure map

The AI pulls all categories and custom pages to build a visual or text-based tree of your docs.

CONTENT

Page inventory

It lists every individual document within a category so you can see exactly what is covered.

GAPS

Missing information

The AI flags where categories exist without pages or where the hierarchy feels incomplete.

HUMAN

Manual review needed

The AI highlights specific pages that look outdated or redundant for you to verify personally.

The workflow

What your AI does when the request arrives.

The AI moves through your ReadMe instance to build a complete picture of your docs.

  1. Map the tree

    The agent identifies all top-level and nested categories in your documentation.

    list_categories

  2. Inspect categories

    It looks inside specific categories to see how they are organized.

    get_category

  3. Find custom pages

    The AI locates any custom pages that sit outside the standard category structure.

    list_custom_pages

  4. Audit page content

    It pulls the specific documents within a category to check for depth and relevance.

    get_category_docs

Try it

Copy these to start.

Use these prompts to kick off your audit.

Starting points

Swap out the specific category names or page titles to target your audit.

ReadMe Connector

You're all set. Choose your MCP client and follow the setup instructions.

Connector linkhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Follow the steps below to connect in seconds.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Configuration · claude_desktop_config.jsonCopy
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
Copy into chat04

  • List all the categories in my ReadMe documentation and show me the hierarchy.

  • Check the 'API Reference' category and tell me if any pages seem to be missing.

  • Find all custom pages in my documentation and list them by name.

  • Look at the docs in the 'Getting Started' category and identify any redundant pages.

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Start here

Connect ReadMe once, then ask.

Just link your ReadMe account to Vinkius. Your credentials stay encrypted, and you can immediately start asking questions about your docs in your preferred AI client.

Connect ReadMe to your AI

FAQ

How this task behaves

  • 01

    Can the AI edit my documentation pages?

    No. The AI can only read your structure and content. You must make all edits manually in ReadMe.

  • 02

    Can the AI delete deprecated content for me?

    No. The AI identifies what should be deleted, but it does not have the permission to remove pages.

  • 03

    Does the AI see my private documentation?

    Yes. The AI can only see the documentation that your ReadMe API credentials have access to.

  • 04

    How does the AI know if a page is outdated?

    The AI compares the content it reads against the instructions or patterns you provide in your prompt.

  • 05

    Can I audit specific sub-categories?

    Yes. You can ask the AI to focus on a single category or a specific set of custom pages.

  • More questions about ReadMe? See everything the ReadMe Connector can do

Connect ReadMe to Claude, Cursor, ChatGPT & more