ReadMe AI

Your Docs Are Better with AI

RewatchTeam Up with AI to Build Docs

MCP Server

Connect your APIs to AI with your own customizable MCP server.

Terminal

Your MCP Server, Powered by ReadMe
███╗   ███╗ ██████╗██████╗ 
████╗ ████║██╔════╝██╔══██╗
██╔████╔██║██║     ██████╔╝
██║╚██╔╝██║██║     ██╔═══╝ 
██║ ╚═╝ ██║╚██████╗██║     
╚═╝     ╚═╝ ╚═════╝╚═╝     
                           
Live at https://docs.your_company.com/mcp

Enabled Endpoints(15)

Select endpoints that are available to AI.

Choose Your Endpoints

Decide which endpoints are available to AI to utilize.

Custom Tools

Functions that LLMs can invoke through MCP to perform actions or retrieve information.

New Tool

Tool Name

eg. pre-execute, data-validator, auth-checker

Description

eg. Call me before any POST request to validate authentication and permissions

Body

eg. Always call /api/auth/validate before anything else. Include user token in Authorization header and verify response status is 200 before proceeding with the main request.

Build Your Own Tools

Your tools are generated from your API. You choose which endpoints are available.

Ask AI

Let customers ask your API anything. Real-time, source-backed answers from your docs.

Read the Docs

Ask AI

What is ReadMe?

ReadMe makes it easy to create and publish beautiful, interactive API documentation.

Whether you want to work in our WYSIWYG editor or check-in your docs as you code, you can always keep docs in sync. ReadMe offers Git-style workflows with branching and versioning, built-in AI tools, and analytics to help you understand how developers use your API.

More information:

HomeGuidesRecipesAPI ReferenceChangelog

⌘K

Ask AI

Get owl factAsk AI

POST

https://owlstore.readme.com/v3/facts/

Example Owl Facts

The tiniest owl, the Elf Owl, is only 5 inches tall.

A group of owls is called a parliament.

Owls can turn their heads as much as 270 degrees. They’re owlways watching you.

BODY PARAMETERS

int64

quantity

int64 • default 100

The number of facts you want.

fun_facts

boolean • default true

If false, excludes the fun facts.

LANGUAGE

Shell

Node

Ruby

PHP

CREDENTIALS

Basic

••••1114

REQUEST

curl --request GET \

--url https://travel.hoot.at/api/v1/tours \

--header 'accept: application/json' \

--header 'authorization:••••1114'

RESPONSE

[ { "id": "111424", "fact": "Owls are farsighted and cannot clearly see anything nearer than a few centimetres of their eyes." } ]

Example Question 1

How do I create a new user?

Add Question

Forbidden Language

eg. darn, heck, damn

Add More

Custom Knowledge

eg. product details, pricing, etc.

Model

gpt-4o

Customize the Experience

Add your own examples, custom tone, forbidden language, and hidden knowledge.

Date

Question

Answer

1h ago

How do I rename a user?

You can rename a user by going to the user’s profile and clicking the “Rename” button.

1d ago

How do I change my payment method?

You can change your payment method by going to the user’s profile and clicking the “Change Payment Method” button.

2d ago

Make a cURL request for a quote with node.js

Code example: curl -X POST https://api.example.com/quote -H "Content-Type: application/json" -d '{"node_js": true}'

2d ago

How do I delete a user?

You can delete a user by going to the user’s profile and clicking the “Delete” button.

2d ago

How long does it take to get a quote?

It takes 24 hours to get a quote.

2d ago

What’s your uptime?

Our uptime is 99.99%.

See Past Asks

See what your customers have asked in the past, and how your Ask AI responded.

Meet

Agent Owlbert

The doc-writing assistant that edits for clarity, suggests what’s missing, and keeps docs aligned with your API.

Read the Docs

Icon Page Public

## What It Can Do

The AI Agent provides comprehensive documentation assistance like: content creation & editing; research & analysis; smart components; and multi-step workflows.

## Getting Started

Access the AI Agent through:

Ask Agent Owlbert

Use Accordions in the FAQ section

agent-owlbert.mdx+3 lines-2 lines

## What It Can Do

The AI Agent provides comprehensive documentation assistance like: content creation & editing; research & analysis; smart components; and multi-step workflows.

</Accordion>

Ask to add tabs, cards, accordions, and more MDX components to your docs.

Ask Agent Owlbert

Fix issues highlighted by the style guide

agent-owlbert.mdx+1 lines-1 lines

## What Can It Do?

## Agent Owlbert Capabilities

The AI Agent provides comprehensive documentation assistance like: content creation & editing; research & analysis; smart components; and multi-step workflows.

Questions in Headings

Avoid section headings in the form of a question.

Agent Owlbert has the context to conform to your own style guide, fix syntax errors, and more.

Doc-writing assistant that edits for clarity, suggests what’s missing, and keeps docs aligned with your API.Doc-writing assistant that edits for clarity, suggests what’s missing, and keeps docs aligned with your API.Doc-writing assistant that edits for clarity, suggests what’s missing, and keeps docs aligned with your API.Doc-writing assistant that edits for clarity, suggests what’s missing, and keeps docs aligned with your API.

Score 8.6/10

Save

Fix Issues

Passive VoicePassive voice detected: ‘The configuration file can be created.’ Use active voice: ‘Create the configuration file.’ for clarity.
Example IntegrityA variable user_id is used in the code block without being defined previously on this page.

Spot Issues With

AI Linter

Fix errors, and polish content with an AI Linter built into your workflow.

Fix my typos
Check for consistent tone
Am I too wordy?
Is the language inclusive?

Automatically Fix Issues

Agent Owlbert has all the context to fix your style guide issues automatically.

Catch Issues Before Publishing

Run the Linter as you write, before saving or on a branch so you don’t have to wait until the end to catch issues.

Docs With

Docs Audit

Enforce voice, terminology, and structure at scale with automated audits.

Read the Docs

Name	Score	Errors	Warnings	Last Edited
OAuth Workflows	9.0/10	3	5	25 days ago
API Migration Guide	9.0/10	3	5	26 days ago
Versioning	8.0/10	5	5	26 days ago
Accessibility Compliance	7.0/10	3	5	26 days ago
Technical FAQ	3.0/10	3	5	26 days ago
Getting Started	5.0/10	3	5	26 days ago
Authentication	5.0/10	3	5	26 days ago

Getting Started

Score 5.0/10

3 Errors

5 Warnings

Overall Score 09/18/25 9:35 PM

5/10

The documentation content is conversational and informal, frequently employing marketing-oriented language and anthropomorphism. This approach deviates from the style guide’s emphasis on simplicity, clarity, and a professional tone. Additionally, the content uses internal jargon impacting its overall quality.

Write Your Own Rules

Add rules that capture your unique style guide and we'll surface errors and warnings.

Historical Scores

Track how well your documentation is following your style guide over time.

Looking to deploy enterprise AI?

Let us help you build reliable and secure production-ready AI features.

SOC2

SOC2 Compliant

Fully SOC 2 compliant platform.

Training

No Training

We never train on your data.