plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "documentation-ai",
  "version": "1.0.0",
  "description": "Search, read, write, edit and publish Documentation.AI docs, knowledge bases, help centers and API references through the Documentation.AI Authoring MCP server.",
  "author": {
    "name": "Keevs Health Inc.",
    "email": "support@documentation.ai",
    "url": "https://documentation.ai"
  },
  "homepage": "https://documentation.ai/docs/ai/authoring-mcp-server",
  "keywords": [
    "documentation",
    "knowledge base",
    "help center",
    "api reference",
    "mdx",
    "technical writing"
  ],
  "extensions": {
    "com.openai": {
      "interface": {
        "displayName": "Documentation.AI",
        "shortDescription": "Edit docs and knowledge bases",
        "longDescription": "Documentation.AI is a documentation and knowledge platform for product guides, knowledge bases, help centers, and API references. This plugin works directly in your Documentation.AI projects: search and read pages, write new pages, edit existing content, reorganize navigation, manage images and screenshots, and publish when you're ready.\n\nChanges appear as unpublished edits in the same editor your team uses, so you can review the diff before anything goes live. For larger updates, work on a separate working version and apply it to your live site when it's approved.\n\nUse it to:\n- Update pages after a product release or API change\n- Write new guides, help center articles, and changelog entries from a spec or your notes\n- Find and fix outdated steps and inconsistent terminology\n- Move or rename pages, update navigation, and add redirects\n- Import screenshots and diagrams, or replace an outdated screenshot everywhere it appears\n- Review unpublished changes and publish them\n\nSign in with your Documentation.AI account. The plugin reaches only the projects your account can access, with your organization role: Viewers can read, Editors and Admins can edit and publish, and only Admins can delete files from the media library.\n\nLimitations: search covers the published site, so content that exists only as unpublished changes is found by browsing files rather than by search. Images are imported from public https links or uploaded through a short-lived link. The plugin does not edit documentation hosted on other platforms.",
        "developerName": "Keevs Health Inc.",
        "category": "Productivity",
        "capabilities": [
          "Search and read documentation pages",
          "Write and edit MDX pages",
          "Reorganize navigation and add redirects",
          "Import and replace images and files",
          "Work on separate working versions",
          "Review diffs and publish changes"
        ],
        "websiteURL": "https://documentation.ai",
        "supportURL": "https://documentation.ai/contact",
        "privacyPolicyURL": "https://documentation.ai/legal/privacy",
        "termsOfServiceURL": "https://documentation.ai/legal/terms",
        "defaultPrompt": [
          "Find every page in our docs that mentions the old pricing tiers and update them on a new working version.",
          "Write a help center article on resetting two-factor authentication from my notes and add it under Account.",
          "Move all billing pages into a Billing group and add redirects for the old URLs."
        ],
        "brandColor": "#1A1A1A",
        "brandColorDark": "#F5F5F5",
        "composerIcon": "./assets/icon.png",
        "logo": "./assets/logo.png"
      },
      "review": {
        "test_cases": {
          "positive": [
            {
              "description": "Find and read docs: search a documentation project and summarize the best matching page without changing anything.",
              "prompt": "List my Documentation.AI projects, then search the Aetherflow docs for how triggers start a workflow and summarize the best matching page with a link to it.",
              "tools_triggered": "list_projects, search, fetch",
              "expected_behavior": "Aetherflow appears in the project list. search returns matching Aetherflow pages, such as Using Triggers, each with a title, file path and a URL on aetherflow-1789972637854448736.documentationai.com. The assistant reads the best match with fetch and summarizes it, citing that URL. Nothing is changed."
            },
            {
              "description": "Edit an existing page on a new working version, without touching the live site.",
              "prompt": "In Aetherflow, create a working version called review-edit. On it, change the title of the Quickstart page to 'Quickstart guide' and show me the diff.",
              "tools_triggered": "create_branch, list_pages, get_page, update_page, diff_page",
              "expected_behavior": "A working version named review-edit is created from the live version. The title in the Quickstart page's frontmatter becomes 'Quickstart guide' on review-edit only, and diff_page shows that single changed line. The change stays unpublished and the live site is unchanged."
            },
            {
              "description": "Write a new page from existing content, add it to the navigation and publish it to a working version.",
              "prompt": "In Aetherflow, create a working version called review-faq. On it, write a new FAQ page at faq.mdx that answers three common questions about building workflows, based only on the existing Building Workflows guide, with each answer in an Expandable component. Add the page to the navigation after Quickstart with an icon, like the other entries there, list the unpublished changes, then publish review-faq.",
              "tools_triggered": "create_branch, get_page, get_component_reference, create_page, get_site_config, update_site_config, list_changes, publish",
              "expected_behavior": "A working version named review-faq is created. faq.mdx is created with a frontmatter title and three Expandable components whose answers come from the Building Workflows guide, and it is added to the navigation after Quickstart with an icon, matching the neighbouring entries. list_changes shows faq.mdx as added and documentation.json as modified. publish succeeds on review-faq only; the live site is unchanged."
            },
            {
              "description": "Bring a public image into the media library, get the snippet to place it on a page, then remove it.",
              "prompt": "Check whether Aetherflow's media library already has an image named apple-icon. If it doesn't, import https://documentation.ai/apple-icon.png with the alt text 'Documentation.AI logo' and give me the MDX snippet to place it on a page. Then delete that image again.",
              "tools_triggered": "search_media, import_media, delete_media",
              "expected_behavior": "search_media finds no image named apple-icon. import_media stores the image in Aetherflow's media library and returns its public address and an MDX Image snippet with the alt text. delete_media then removes the image. No page is changed."
            },
            {
              "description": "Reorganize on a working version, review the change, then discard it and clean up.",
              "prompt": "In Aetherflow, create a working version called review-move. On it, move the Integrations guide into a folder called connections, show me the unpublished changes, then discard all of them and delete the review-move working version.",
              "tools_triggered": "create_branch, list_pages, move_page, list_changes, revert_all_changes, delete_branch",
              "expected_behavior": "A working version named review-move is created. The Integrations guide moves into connections/ and its navigation entry is updated. list_changes shows the move and the documentation.json change. revert_all_changes then discards the changes and delete_branch deletes review-move. The live site is unchanged throughout."
            }
          ],
          "negative": [
            {
              "description": "Question about another company's public documentation. The plugin works only with the user's own Documentation.AI projects, so it should not act: nothing in Documentation.AI is created, changed or published, and the assistant answers from general knowledge or web search instead.",
              "prompt": "What does the Stripe API documentation say about idempotency keys?"
            },
            {
              "description": "Request to edit a page on another platform. The plugin cannot reach Confluence, so it should not act: nothing in Documentation.AI is created, changed or published, and the assistant explains it cannot edit Confluence from here or asks for the steps and the right tool.",
              "prompt": "Update our Confluence onboarding page with the new VPN setup steps."
            },
            {
              "description": "Request for a code comment in source code, not a documentation page. The plugin should not act: nothing in Documentation.AI is created, changed or published, and the assistant writes the docstring in the conversation.",
              "prompt": "Add a docstring to this Python function: def add(a, b): return a + b"
            }
          ]
        },
        "demo_recording_url": "https://www.loom.com/share/5d67c0d513f24b81a08f4bd8ee83e3b8",
        "commerce": false,
        "commerce_description": "This plugin does not sell products or process payments."
      },
      "publication": {
        "countries": [],
        "release_notes": "Initial release. Search, read, write, edit and publish Documentation.AI docs, knowledge bases and help centers. Includes working versions, review of unpublished changes and diffs, navigation and site configuration updates, and media library management for images and screenshots."
      },
      "apps": "./.app.json"
    }
  }
}