.codex-plugin/plugin.json

{
  "name": "redocly",
  "version": "0.1.5",
  "description": "Write, lint and document APIs with Redocly. Skills for Redocly CLI, lint rules and Redocly docs projects, plus live search across the Redocly documentation through the Redocly MCP server.",
  "author": {
    "name": "Redocly",
    "email": "team@redocly.com",
    "url": "https://redocly.com"
  },
  "homepage": "https://redocly.com/docs",
  "repository": "https://github.com/Redocly/redocly-plugin",
  "license": "MIT",
  "keywords": [
    "redocly",
    "openapi",
    "asyncapi",
    "arazzo",
    "api-docs",
    "lint",
    "documentation"
  ],
  "skills": "./skills/",
  "mcpServers": "./.mcp.json",
  "interface": {
    "displayName": "Redocly",
    "shortDescription": "Write, lint and document APIs.",
    "longDescription": "Write, lint and document APIs with Redocly. Skills for Redocly CLI, lint rules and Redocly docs projects, plus live search across the Redocly documentation through the Redocly MCP server.",
    "developerName": "Redocly",
    "logo": "./assets/logo.png",
    "composerIcon": "./assets/logo.png",
    "category": "Developer Tools",
    "capabilities": [
      "Read",
      "Write"
    ],
    "websiteURL": "https://redocly.com",
    "privacyPolicyURL": "https://redocly.com/privacy-notice",
    "termsOfServiceURL": "https://redocly.com/subscription-agreement",
    "supportURL": "https://redocly.com/contact-us",
    "defaultPrompt": [
      "Lint my OpenAPI description with Redocly CLI and explain each problem.",
      "Write a Redocly lint rule that requires an operationId on every operation.",
      "Set up a Redocly docs site for my OpenAPI description."
    ]
  },
  "extensions": {
    "com.openai": {
      "review": {
        "test_cases": {
          "positive": [
            {
              "description": "Finds which identity providers a Reunite organization accepts, and reads the page to confirm.",
              "prompt": "Search the Redocly docs: which identity providers can I add to a Reunite organization? Link the page.",
              "tools_triggered": "search, get-page",
              "expected_behavior": "Calls search, then get-page on the page about adding an identity provider. Answers SAML 2 and OpenID Connect, each as a corporate or a guest identity provider. Links https://redocly.com/docs/realm/reunite/organization/sso/add-idp.",
              "expected_output_url": "https://redocly.com/docs/realm/reunite/organization/sso/add-idp"
            },
            {
              "description": "Lists the pages in one section of the Redocly docs navigation.",
              "prompt": "Show me the Redocly docs navigation for the Make docs AI ready section, with a link to each page.",
              "tools_triggered": "list-pages",
              "expected_behavior": "Calls list-pages for the section Make docs AI ready. It can call list-pages for the top level first. Lists five pages with links: MCP servers, Redocly MCP server, Custom MCP tools, Agent skills, and WebMCP tools. Adds no page that the tool did not return."
            },
            {
              "description": "Finds every docs line that contains an exact text.",
              "prompt": "Which Redocly docs pages mention ssl.redocly.app? Quote the lines.",
              "tools_triggered": "grep-pages",
              "expected_behavior": "Calls grep-pages with the text ssl.redocly.app. It can call search first. Reports two pages and quotes their lines: Set a custom domain (https://redocly.com/docs/realm/reunite/project/custom-domain), which says to point the CNAME record to ssl.redocly.app, and Migrate from legacy portal (https://redocly.com/docs-legacy/developer-portal/migrate-from-legacy-portal)."
            },
            {
              "description": "Explains what Respect Monitoring checks, from the current Redocly documentation.",
              "prompt": "Search the Redocly docs: what does Respect Monitoring in Reunite check? Link the page.",
              "tools_triggered": "search",
              "expected_behavior": "Calls search, and can call get-page to read the page. Answers that Respect Monitoring runs Arazzo workflows against the API and checks status codes, success criteria, response schemas, and content types against the OpenAPI description. Links https://redocly.com/docs/realm/reunite/project/respect-monitoring.",
              "expected_output_url": "https://redocly.com/docs/realm/reunite/project/respect-monitoring"
            },
            {
              "description": "Reports a documentation problem to the Redocly docs team. This is the only tool that writes data. It creates one feedback record and changes nothing else.",
              "prompt": "Send feedback to the Redocly docs team: the page /docs/cli/v2/quickstart should show how to check the installed CLI version.",
              "tools_triggered": "submit-feedback",
              "expected_behavior": "The client asks the user to approve the submit-feedback call before it runs. After approval, calls submit-feedback once with the path /docs/cli/v2/quickstart and a one-sentence summary. Tells the user that the docs team received the report."
            }
          ],
          "negative": [
            {
              "description": "A question about another vendor's product, Swagger UI. The Redocly docs do not cover it. Expected: the assistant answers from general knowledge or says that the question is outside the Redocly docs. It calls no Redocly tool and does not present Redoc settings as Swagger UI settings.",
              "prompt": "How do I enable deep linking in Swagger UI?"
            },
            {
              "description": "A change to a Reunite project. The plugin can only read the docs and report a docs problem. It cannot change projects. Expected: the assistant says that it cannot change the project, and it can link the docs steps. It does not claim that the domain is set, and it does not call submit-feedback.",
              "prompt": "Set the custom domain docs.acme.com on my Redocly Reunite project."
            },
            {
              "description": "A feedback request without the page or the problem. submit-feedback needs both. Expected: the assistant asks which page is wrong and what is wrong. It does not call submit-feedback until the user gives both, and it does not invent a page or a problem.",
              "prompt": "Report a problem with the Redocly docs."
            }
          ]
        },
        "demo_recording_url": "https://drive.google.com/file/d/1dQdrWZ2xvGEPra5jJaZSgMl7k92c9hQr/view?usp=sharing"
      },
      "publication": {
        "release_notes": "First release. Redocly skills for Redocly CLI commands, redocly.yaml configuration, custom lint rules, Markdown linting with recheck, and Redocly docs projects, plus the Redocly MCP server, which searches the current Redocly documentation and can report a documentation problem to the Redocly docs team."
      }
    }
  },
  "apps": "./.app.json"
}