Agent

The Agent drafts, edits, and researches documentation from the AI chat panel in your editor. It uses the context of your current page and OpenAPI spec to produce output that matches your actual endpoints and parameters. You can ask it to write a getting started guide from your API spec, translate a page into Spanish, replace outdated terminology across your entire site, or scan every page for missing code examples — all in a single prompt.

Getting Started

1. Open any page in your ReadMe project.
2. The AI Agent panel lives in the right side AI Tools panel 
3. Type a prompt. The Agent responds using the context of your documentation and OAS file. 

To choose a specific model, use the model picker at the bottom of the chat input. Otherwise ReadMe auto-selects one.

Configure

Open AI → Agent Settings to:

• Disable specific models that aren't compatible with your documentation.
• Index your codebase to give the Agent additional context.
• Add custom content that the Agent can reference.

Examples

Draft a guide from your API spec

Write a getting started guide for our authentication API. Include code
examples for getting an API key, making a first request, and handling errors.

The Agent reads your OpenAPI spec, finds the auth endpoints, and produces a full page with accurate parameter names, request/response examples, and proper MDX formatting.

Audit your docs for consistency

Find every page that mentions "API key" and check if they all describe
the same process for getting one. List any inconsistencies.

The Agent scans your entire site, compares the content across pages, and returns a report showing which pages are out of sync.

Rewrite a section from a URL

Read https://example.com/changelog and update our "What's New" page
with the latest three releases.

The Agent fetches the URL, extracts the relevant content, and writes it into your page formatted to match your existing style.

Fix linter issues across your site

Run the linter on every page and fix all errors automatically.

The Agent applies your style guide rules, identifies violations, and resolves them in place across your entire project.

FAQ