Skip to content

Rank #5 of 5 in Developer Docs Platforms

npm 97.7k/wk

Showcase

ReadMe homepage screenshot
homepage · captured Sep 2026 · view live ↗
ReadMe docs screenshot
docs · captured Sep 2026 · view live ↗

Try itExperimental

See what an agent can do with ReadMe before you ever sign up. Pick a story: recorded sessions replay real probe-harness transcripts; commands tagged live-capable can re-run against the real endpoint from our edge, right now (▶ run live — the exact same request, live and recorded lines always labeled); sandboxed self-drive sessions are designed and gated (docs/TRY-IT.md).

$npx -y rdme --versionrecorded session — replayed, not live
recorded 2026-09-08 · exit 0 · captured verbatim by our probe harness, secrets redacted

Verified integrations

No integration evidence found in our corpus for this product yet — that means none was found, never that it doesn’t integrate.

By theme — the product's score on each story themeBy theme

Agenticness — how well agents can access and operate the productAgenticnessevidence →

How well agents can access and operate the product

36.8/100

Ai docs — stories about ai docs in this arenaAi docsevidence →

Stories about ai docs in this arena

65.1/100

Analytics insights — stories about analytics insights in this arenaAnalytics insightsevidence →

Stories about analytics insights in this arena

33.0/100

Api reference — stories about api reference in this arenaApi referenceevidence →

Stories about api reference in this arena

80.0/100

Authoring editing — stories about authoring editing in this arenaAuthoring editingevidence →

Stories about authoring editing in this arena

58.8/100

Automation depth — how much of the product can run unattendedAutomation depthevidence →

How much of the product can run unattended

13.0/100

Collaboration review — stories about collaboration review in this arenaCollaboration reviewevidence →

Stories about collaboration review in this arena

36.0/100

Customization — bending the product to your needs — settings, theming, extension pointsCustomizationevidence →

Bending the product to your needs — settings, theming, extension points

80.0/100

Docs as code — stories about docs as code in this arenaDocs as codeevidence →

Stories about docs as code in this arena

34.3/100

Openness — open source, data portability, and self-hosting storiesOpennessevidence →

Open source, data portability, and self-hosting stories

16.2/100

Privacy posture — data-handling and privacy storiesPrivacy postureevidence →

Data-handling and privacy stories

0.0/100

Publishing hosting — stories about publishing hosting in this arenaPublishing hostingevidence →

Stories about publishing hosting in this arena

39.2/100

Search discovery — stories about search discovery in this arenaSearch discoveryevidence →

Stories about search discovery in this arena

0.0/100

Versioning localization — stories about versioning localization in this arenaVersioning localizationevidence →

Stories about versioning localization in this arena

22.5/100

Story verdicts — every judged story with its evidenceStory verdicts

?

Sorted by importance (agentic first) (high → low) · 53/53 stories · click a row’s chevron for the rationale and evidence

Connect an agent via an official MCP server G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness3full8/10T

Drive the product through a documented public API G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness3full8/10T

Delegate tasks to a built-in AI assistant inside the product G

Agentic features

ai-native userAgenticness — how well agents can access and operate the productAgenticness3partial6/10C

Plug MCP servers into this product so it can use their tools G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness3none0/10

Point an agent at llms.txt or agent-oriented docs G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2full9/10T

Explore an interactive API reference with runnable examples G

Api quality

ai-native userAgenticness — how well agents can access and operate the productAgenticness2full8/10X

Get AI-generated insights and suggestions from my data inside the product G

Agentic features

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial6/10C

Operate the product with natural-language commands G

Agentic features

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial6/10C

Run the product headlessly / in CI for automation G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial6/10T

Use an official CLI G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial5/10T

Set up automations that run autonomously in the background G

Agentic features

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial4/10C

Build against official SDKs G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2partial3/10T

Download a machine-readable API spec (OpenAPI or equivalent) G

Api quality

ai-native userAgenticness — how well agents can access and operate the productAgenticness2none0/10

Rely on versioned APIs with a documented deprecation policy G

Api quality

ai-native userAgenticness — how well agents can access and operate the productAgenticness2none0/10

Issue scoped/least-privilege API credentials for an agent G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2noneuntestednone yet

Subscribe to events via webhooks G

Agent access

ai-native userAgenticness — how well agents can access and operate the productAgenticness2n/auntestednone yet

Test against a sandbox environment without touching production data G

Api quality

ai-native userAgenticness — how well agents can access and operate the productAgenticness1none0/10

My API reference pages are generated from an OpenAPI spec and stay in sync when the spec changes C

Spec driven

developerApi reference — stories about api reference in this arenaApi reference3full8/10X

My docs live in my own git repository — branches, pull requests, and merges drive what gets published C

Git workflow

developerDocs as code — stories about docs as code in this arenaDocs as code3full8/10C

My published docs site automatically serves llms.txt (and a full-content variant) so agents can index it C

Agent output

ai-native userAi docs — stories about ai docs in this arenaAi docs3full8/10T

My published docs site exposes its own MCP server that my users' agents can query for search and page content C

Agent access

ai-native userAi docs — stories about ai docs in this arenaAi docs3full8/10T

Every published page serves clean markdown at its URL (e.g. appending .md) so agents skip the HTML C

Agent output

ai-native userAi docs — stories about ai docs in this arenaAi docs3full7/10T

Export all of my data in open formats and leave G

ai-native userOpenness — open source, data portability, and self-hosting storiesOpenness3partial5/10C

I author pages in Markdown/MDX with rich components — tabs, callouts, code groups, steps — without writing custom HTML C

Authoring

technical writerAuthoring editing — stories about authoring editing in this arenaAuthoring editing3partial5/10C

I publish versioned documentation per product or API version, and readers switch versions from the site C

Versioning

developerVersioning localization — stories about versioning localization in this arenaVersioning localization3partial5/10C

Define rules that trigger actions automatically on events G

ai-native userAutomation depth — how much of the product can run unattendedAutomation depth3none0/10

Readers get fast, typo-tolerant, relevance-ranked search over the whole docs site out of the box C

Search

developerSearch discovery — stories about search discovery in this arenaSearch discovery3none0/10

Self-host the core product G

ai-native userOpenness — open source, data portability, and self-hosting storiesOpenness3none0/10

Prevent my data from being used to train AI models G

ai-native userPrivacy posture — data-handling and privacy storiesPrivacy posture3noneuntestednone yet

I customize themes, fonts, and layout — down to custom CSS/JS or my own components — so the docs match my brand C

Theming

devrel leadCustomization — bending the product to your needs — settings, theming, extension pointsCustomization2full8/10X

I serve docs on my own custom domain or as a /docs subpath of my main site C

Domains

devrel leadPublishing hosting — stories about publishing hosting in this arenaPublishing hosting2full8/10C

Non-technical teammates can edit docs in a visual web editor without touching git, and their changes flow into the same source of truth C

Authoring

technical writerAuthoring editing — stories about authoring editing in this arenaAuthoring editing2full8/10C

Readers can try real API calls from an interactive playground embedded in the reference docs C

Playground

developerApi reference — stories about api reference in this arenaApi reference2full8/10X

A platform AI agent drafts, updates, and reviews my docs — from a prompt, a PR, or a schedule — and ships its work as change requests C

Writer agent

ai-native userAi docs — stories about ai docs in this arenaAi docs2partial7/10C

Automated checks lint my content against a style guide and flag issues before they publish C

Quality

technical writerAuthoring editing — stories about authoring editing in this arenaAuthoring editing2full7/10C

An embedded AI assistant on my docs site answers reader questions with citations into my content C

Assistant

ai-native userAi docs — stories about ai docs in this arenaAi docs2partial6/10C

Do everything through the API that I can do in the UI G

ai-native userOpenness — open source, data portability, and self-hosting storiesOpenness2partial6/10T

My docs analytics distinguish AI-agent traffic from human traffic so I can see who — or what — is actually reading C

Analytics

ai-native userAnalytics insights — stories about analytics insights in this arenaAnalytics insights2partial6/10C

Teammates propose changes that go through review — comments, approvals, and a merge step — before they publish C

Review

technical writerCollaboration review — stories about collaboration review in this arenaCollaboration review2partial6/10C

I see page views, search terms, and reader feedback so I know which docs work and which fail C

Analytics

devrel leadAnalytics insights — stories about analytics insights in this arenaAnalytics insights2partial5/10C

Perform bulk operations across many items at once G

ai-native userAutomation depth — how much of the product can run unattendedAutomation depth2partial4/10T

Export my entire docs site as a static bundle and host it anywhere, so my content is never locked in C

Portability

developerPublishing hosting — stories about publishing hosting in this arenaPublishing hosting2partial3/10C

CI validation catches broken links and invalid configuration before the site publishes C

Quality gates

developerDocs as code — stories about docs as code in this arenaDocs as code2none0/10

Control data retention and deletion G

ai-native userPrivacy posture — data-handling and privacy storiesPrivacy posture2none0/10

Choose where my data is stored (region/residency) G

ai-native userPrivacy posture — data-handling and privacy storiesPrivacy posture2noneuntestednone yet

Every docs pull request gets a shareable preview deployment before it merges C

Git workflow

developerDocs as code — stories about docs as code in this arenaDocs as code2noneuntestednone yet

Opt out of telemetry and usage tracking G

ai-native userPrivacy posture — data-handling and privacy storiesPrivacy posture2noneuntestednone yet

Read the product's source under an open license G

ai-native userOpenness — open source, data portability, and self-hosting storiesOpenness2noneuntestednone yet

Schedule recurring jobs or workflows G

ai-native userAutomation depth — how much of the product can run unattendedAutomation depth2n/auntestednone yet

Reusable snippets and variables keep repeated content in sync across pages C

Content reuse

technical writerAuthoring editing — stories about authoring editing in this arenaAuthoring editing1full8/10C

Version, review, and roll back my automations G

ai-native userAutomation depth — how much of the product can run unattendedAutomation depth1partial5/10C

I gate some or all docs behind authentication — password, JWT, or SSO — for customers-only content G

Access control

devrel leadPublishing hosting — stories about publishing hosting in this arenaPublishing hosting1none0/10

I publish my docs in multiple languages with translated navigation and content C

Localization

technical writerVersioning localization — stories about versioning localization in this arenaVersioning localization1noneuntestednone yet

Opportunities — the stories that would move this product's scores, from its own judged verdictsOpportunitiestop 8 of 36 stories with headroom

What would move ReadMe’s scores — derived from its own judged verdicts, biggest headroom first. Each line quotes what the judge found missing; shipping it (or evidencing it publicly) is the fix.

  1. Agenticness — how well agents can access and operate the productPlug MCP servers into this product so it can use their tools

    nonemoves agent-readyimpact 45

    All MCP-related evidence describes ReadMe publishing its own MCP server so external AI coding assistants (Cursor, Claude Code, VS Code Copilot) can call ReadMe's API/docs tools (readme-docs-3, readme-docs-34, readme-probe-2) — this is the server role, the opposite of what the story asks.

  2. Automation depth — how much of the product can run unattendedDefine rules that trigger actions automatically on events

    nonemoves PA Scoreimpact 30

    Missing: an event-trigger/automation rules engine, webhook or conditional action framework, evidence of user-defined triggers beyond docs linting/sync.

  3. Search discovery — stories about search discovery in this arenaReaders get fast, typo-tolerant, relevance-ranked search over the whole docs site out of the box

    nonemoves PA Scoreimpact 30

    The evidence pack describes Ask AI (AI-generated answers from docs) and MCP/agent discoverability features, but contains no mention of a traditional full-text search index, typo-tolerance, or relevance ranking for the docs site itself.

  4. Openness — open source, data portability, and self-hosting storiesSelf-host the core product

    nonemoves PA Scoreimpact 30

    ReadMe is a SaaS-only hosted documentation platform; there is no evidence of a self-hostable core product, Docker image, or on-prem deployment option.

  5. Privacy posture — data-handling and privacy storiesPrevent my data from being used to train AI models

    nonemoves PA Scoreimpact 30

    No evidence in the pack addresses AI training data opt-out or any data-privacy controls related to AI model training; ReadMe's docs cover documentation/AI-assistant features but not this privacy posture.

  6. Agenticness — how well agents can access and operate the productIssue scoped/least-privilege API credentials for an agent

    nonemoves agent-readyimpact 30

    While ReadMe exposes an MCP server and a general ReadMe API, the evidence pack contains no mention of issuing scoped or least-privilege API credentials specifically for AI agents (e.g., agent-specific API keys, permission scopes, or token restrictions) — only general API key injection for docs personalization and generic API access control.

  7. Agenticness — how well agents can access and operate the productDownload a machine-readable API spec (OpenAPI or equivalent)

    nonemoves API qualityimpact 30

    Missing: any documented spec-download endpoint, export-as-OpenAPI option, or explicit machine-readable API spec retrieval capability.

  8. Agenticness — how well agents can access and operate the productRely on versioned APIs with a documented deprecation policy

    nonemoves API qualityimpact 30

    Evidence shows ReadMe offers a 'Versions' feature for customers' own API docs (readme-docs-17, 48, 69) and exposes its own ReadMe API for programmatic control (readme-docs-87), but there is no documentation of a versioning scheme or deprecation policy for ReadMe's own API/product that an AI-native consumer could rely on.

Showing the top 8 of 36 — every none/partial verdict in the story verdicts table is headroom.

Think a verdict is wrong? Every verdicts-table row has a Flag link — see the methodology.

Coverage map — which docs area, API section, or community source covers which judged storiesCoverage map5 surfaces · 34 covered stories

Where the cited evidence behind each covered verdict came from — the same citations the verdicts table shows, no extra judging.

Main docs33 stories

Probe proofs — replayable recordings from the probe harnessProbe proofs

Replayable recordings from our probe harness — see the Prove-It protocol to submit one.

$npx -y rdme --versionreproduced
$ npx -y rdme --version
rdme/10.9.6 darwin-arm64 node-v26.0.0
$curl -s -X POST https://docs.readme.com/mcp -H 'Content-Type: application/json' -d '<jsonrpc initialize>' # the per-project MCP server ReadMe ships, on its own docsreproduced
$ curl -s -X POST https://docs.readme.com/mcp -H 'Content-Type: application/json' -d '<jsonrpc initialize>'  # the per-project MCP server ReadMe ships, on its own docs
event: message
data: {"result":{"protocolVersion":"2025-06-18","capabilities":{"tools":{"listChanged":false}},"serverInfo":{"name":"ReadMe Documentation","version":"1.0.0"}},"jsonrpc":"2.0","id":1}
$curl -sL 'https://docs.readme.com/llms.txt?query=mcp+server' | head -12 # llms.txt with built-in search, on ReadMe's own docsreproduced
$ curl -sL 'https://docs.readme.com/llms.txt?query=mcp+server' | head -12  # llms.txt with built-in search, on ReadMe's own docs
# ReadMe Documentation Documentation

> Beautiful documentation made easy.

Append .md to any documentation page URL to get its markdown version.

Pages matching `mcp server`, most relevant first. Fetch https://docs.readme.com/llms.txt for the complete index.

## Search Results
- [ReadMe's MCP Server](https://docs.readme.com/main/docs/readmes-mcp-server.md) (ReadMe · Guides): Search, read, and update your documentation from any AI coding assistant or CI pipeline.
- [MCP Metrics](https://docs.readme.com/main/docs/mcp-metrics.md) (ReadMe · Guides): See which tools AI agents call on your MCP server, how fast those calls return, and what they asked for.
- [MCP](https://docs.readme.com/main/docs/your-projects-mcp-server.md) (ReadMe · Guides): Give your users' AI tools live access to your API spec and docs.
$curl -sL https://docs.readme.com/main/docs/your-projects-mcp-server.md | head -12reproduced
$ curl -sL https://docs.readme.com/main/docs/your-projects-mcp-server.md | head -12
---
updatedAt: 2026-08-21T03:05:09.000Z
---

Fetch the complete documentation index at: https://docs.readme.com/main/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

If a page title in the index already matches your question, fetch that page directly. When no title matches, or finding one means reading a long index, attach a query parameter in the root llms.txt URL like https://docs.readme.com/main/llms.txt?query=<search-query> using 2-4 specific [redacted]words to get only the matching pages, most relevant first.

# MCP

Give your users' AI tools live access to your API spec and docs.

Claims vs evidence — vendor claims reconciled against independent verdictsClaims vs evidence

5 of 16 testable claims verified · 0 contradictedintegrity 31/100

19 distinct capability claims found in ReadMe’s own claimed-docs/GitHub materials, reconciled against our judge’s independent verdicts.

5

Verified

11

Unverified

0

Contradicted

18

Undersold

Verified (5)
Unverified (13)
Undersold (18)
Claims outside our story set (2)

Real capability claims found in ReadMe’s own materials, but no story in this arena’s taxonomy covers them yet — that’s feedback on the taxonomy, not a mark against the product.

  • ReadMe crawls a sample of published pages and scores the project against an Agent-Friendly Docs spec

    source ↗
  • API Metrics report call volume, endpoint usage, and errors for insight into API usage

    source ↗
Suggest a story for these →

Business model

free-tiersubscription-flatenterprise-custom

Starter plan is free; Pro is $250/month per project with AI features (Ask AI is a $150/month add-on); Enterprise is custom with annual billing.

pricing ↗

Score trend

How this product’s scores have moved as evidence and verdicts are re-derived — a point per change, not per day.

PA Score29 (Sep 8 '26)28 (Sep 16 '26)
Agent-ready45 (Sep 8 '26)44 (Sep 16 '26)

Try Experimental

Run it in the microterminal →

Recorded agent sessions — and a live MCP handshake where the vendor ships one.

Flag

⚑ Flag a verdict

Think a verdict is wrong? Opens a prefilled GitHub issue — or use the ⚑ next to any verdict above.

Badge

Embed this product's score badge →

Hotlinked SVG — always shows the live current score.

For agents

Data

Agent surface uptime MCP up · llms.txt up (tracking since Sep 10 '26)