How ReadMe’s scores are calculated
The full audit trail, recomputed from the verdict data at build time through the same code that produced the leaderboard: verdict × quality × story weight per cell, cells sum to dimension scores, dimensions blend into the PA Score. Every number on the product page is reproducible from this page alone; for why the formula looks like this, see the methodology.
verdict factors: full ×1.0 · partial ×0.6 · disputed ×0.3 · none ×0.0 · n/a excluded from both sides · cell points = weight × quality × factor · cell max = weight × 10
PA Score28/100
Agent-ready 43.6 × 0.30 = 13.08
API quality 22.9 × 0.20 = 4.58
Openness 16.2 × 0.20 = 3.24
Built-in AI 33.3 × 0.15 = 4.99
Automation 13.0 × 0.15 = 1.95
(13.08 + 4.58 + 3.24 + 4.99 + 1.95) ÷ (0.30 + 0.20 + 0.20 + 0.15 + 0.15) = 27.84 ÷ 1.00 = 27.8
Scores are stored to 1 decimal; the product page’s pills round to whole numbers for display. Each dimension below shows the stories, verdicts, and cited evidence behind its number.
Agent-ready43.6/100×0.30 of the PA blend
Outside-in: can YOUR agent reach and drive this product — API, MCP, CLI, headless runs, agent docs.
Point an agent at llms.txt or agent-oriented docsweight 2
2 (weight) × 9 (quality) × 1.0 (full) = 18.0 of 20 max
- [probe] https://docs.readme.com/llms.txt“PROBE llms.txt: HTTP 200 at https://docs.readme.com/llms.txt # ReadMe Documentation Documentation > Beautiful documentation made easy. Append .md to any documentation page URL to”
- [claimed-docs] https://docs.readme.com/main/docs/ai-discoverability“Make your documentation discoverable and accessible to AI agents and the assistant”
- [claimed-docs] https://docs.readme.com/main/docs/ai-discoverability“ReadMe crawls a sample of your published pages and scores your project against the Agent-Friendly Docs spec, so you can see at a glance where your docs stand”
- [claimed-docs] https://docs.readme.com/main/docs/llms.txt“Get your API documentation live in three steps: create a project, upload your API definition, and write your first guide.”
- [claimed-docs] https://docs.readme.com/main/docs/customizing-docs/llms.txt“Set your hub's look from four theme presets, then tune brand colors and typography in Appearance settings.”
- [claimed-docs] https://docs.readme.com/main/docs/workflows/llms.txt“Run documentation entirely through Git, with Markdown and OpenAPI in your repository and pull requests as the review step.”
- [claimed-docs] https://docs.readme.com/main/docs/ai/llms.txt“Draft, edit, and research documentation from the AI chat panel.”
- [probe] https://docs.readme.com/main/docs/your-projects-mcp-server“official MCP server documented at https://docs.readme.com/main/docs/your-projects-mcp-server”
Run the product headlessly / in CI for automationweight 2
2 (weight) × 6 (quality) × 0.6 (partial) = 7.2 of 20 max
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
- [claimed-docs] https://docs.readme.com/main/docs/workflows/llms.txt“Run documentation entirely through Git, with Markdown and OpenAPI in your repository and pull requests as the review step.”
Plug MCP servers into this product so it can use their toolsweight 3
3 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 30 max
- [claimed-docs] https://docs.readme.com/main/docs/your-projects-mcp-server“Your MCP server gives AI coding assistants — Cursor, Claude Code, VS Code Copilot — a live connection to your API spec and documentation.”
- [claimed-docs] https://docs.readme.com/main/docs/your-projects-mcp-server“Your MCP server gives AI coding assistants — Cursor, Claude Code, VS Code Co”
- [probe] https://docs.readme.com/main/docs/your-projects-mcp-server“official MCP server documented at https://docs.readme.com/main/docs/your-projects-mcp-server”
- [claimed-docs] https://docs.readme.com/main/docs/aiagent“The Agent is a powerful documentation assistant that helps you create, edit, and enhance content across Guides, API References, Custom Pages, and more”
Connect an agent via an official MCP serverweight 3
3 (weight) × 8 (quality) × 1.0 (full) = 24.0 of 30 max
- [claimed-docs] https://docs.readme.com/main/docs/your-projects-mcp-server“Your MCP server gives AI coding assistants — Cursor, Claude Code, VS Code Copilot — a live connection to your API spec and documentation.”
- [claimed-docs] https://docs.readme.com/main/docs/your-projects-mcp-server“Your MCP server gives AI coding assistants — Cursor, Claude Code, VS Code Co”
- [claimed-docs] https://docs.readme.com/main/docs/mcp-metrics“The MCP page in Analytics shows how many calls arrived, how quickly they returned, how many failed, and the query or endpoint behind each call.”
- [claimed-docs] https://docs.readme.com/main/docs/mcp-metrics“Every time an AI client calls a tool on your project's MCP server, ReadMe records the call. The MCP page in Analytics shows how many calls arrived, how quickly they returned”
- [claimed-docs] https://docs.readme.com/main/docs/mcp-metrics“MCP Metrics”
- [probe] https://docs.readme.com/main/docs/your-projects-mcp-server“official MCP server documented at https://docs.readme.com/main/docs/your-projects-mcp-server”
Use an official CLIweight 2
2 (weight) × 5 (quality) × 0.6 (partial) = 6.0 of 20 max
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
Drive the product through a documented public APIweight 3
3 (weight) × 8 (quality) × 1.0 (full) = 24.0 of 30 max
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
- [claimed-docs] https://docs.readme.com/main/reference/developer-metrics-api/llms.txt“See how people use your docs and how developers use your API”
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
- [probe] https://docs.readme.com/llms.txt“PROBE llms.txt: HTTP 200 at https://docs.readme.com/llms.txt # ReadMe Documentation Documentation > Beautiful documentation made easy. Append .md to any documentation page URL to”
Issue scoped/least-privilege API credentials for an agentweight 2
2 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 20 max
no evidence cited — the verdict rests on absence of evidence, re-checked on refresh
Build against official SDKsweight 2
2 (weight) × 3 (quality) × 0.6 (partial) = 3.6 of 20 max
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
- [claimed-docs] https://docs.readme.com/main/docs/getting-started“Pick a language”
Subscribe to events via webhooksweight 2
n/a — not applicable to this product: excluded from numerator and denominator
no evidence cited — the verdict rests on absence of evidence, re-checked on refresh
Agent-ready = 82.8 ÷ 190 × 100 = 43.6
API quality22.9/100×0.20 of the PA blend
The programmable surface once an agent is there — machine-readable spec, interactive docs, sandbox, versioning discipline.
Explore an interactive API reference with runnable examplesweight 2
2 (weight) × 8 (quality) × 1.0 (full) = 16.0 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/api-reference“developers can explore your API, make test calls right from the documentation, and see real responses without writing a single line of code”
- [claimed-docs] https://docs.readme.com/main/docs/openapi-upload-and-management“ReadMe makes it simple to transform your existing OAS file into beautiful, interactive documentation that your developers will actually enjoy using.”
- [community] https://hn.algolia.com/api/v1/items/32867516“My experience is that Readme has better support for Swagger compared to Docusaurus.”
Download a machine-readable API spec (OpenAPI or equivalent)weight 2
2 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/openapi-upload-and-management“ReadMe makes it simple to transform your existing OAS file into beautiful, interactive documentation that your developers will actually enjoy using.”
- [claimed-docs] https://docs.readme.com/main/docs/exporting-data“You can export the files in your docs or as a PDF from the Branch menu.”
- [claimed-docs] https://docs.readme.com/main/docs/exporting-data“You can export the files in your docs or as a PDF from the **Branch** menu.”
Test against a sandbox environment without touching production dataweight 1
1 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 10 max
- [claimed-docs] https://docs.readme.com/main/docs/api-reference“developers can explore your API, make test calls right from the documentation, and see real responses without writing a single line of code”
- [claimed-docs] https://readme.com“Try it out — enter a URL , , or Upload Files , or Drag and Drop”
Rely on versioned APIs with a documented deprecation policyweight 2
2 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/versions“Maintaining multiple versions of your documentation is critical for many different technical products.”
- [claimed-docs] https://docs.readme.com/main/docs/versions“Maintain more than one version of your docs, covering version settings, the reader-facing dropdown, and common use”
- [claimed-docs] https://docs.readme.com/main/docs/version-control/llms.txt“Maintain more than one version of your docs, covering version settings, the reader-facing dropdown, and common use cases.”
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
API quality = 16.0 ÷ 70 × 100 = 22.9
Openness16.2/100×0.20 of the PA blend
Can you leave, inspect, or self-host — data export, open source, portability.
Do everything through the API that I can do in the UIweight 2
2 (weight) × 6 (quality) × 0.6 (partial) = 7.2 of 20 max
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
- [claimed-docs] https://docs.readme.com/main/docs/bi-directional-sync“Bi-directional sync creates a two-way connection between your ReadMe project and a GitHub or GitLab repository.”
- [claimed-docs] https://docs.readme.com/main/docs/bi-directional-sync“Connect your project to a GitHub, GitLab, or Bitbucket repos”
- [claimed-docs] https://docs.readme.com/main/docs/workflows/llms.txt“Run documentation entirely through Git, with Markdown and OpenAPI in your repository and pull requests as the review step.”
- [claimed-docs] https://docs.readme.com/main/docs/workflows/llms.txt“Manage API definitions in Git while your team writes docs in ReadMe, for o”
Export all of my data in open formats and leaveweight 3
3 (weight) × 5 (quality) × 0.6 (partial) = 9.0 of 30 max
- [claimed-docs] https://docs.readme.com/main/docs/exporting-data“You can export the files in your docs or as a PDF from the Branch menu.”
- [claimed-docs] https://docs.readme.com/main/docs/exporting-data“You can export the files in your docs or as a PDF from the **Branch** menu.”
Read the product's source under an open licenseweight 2
2 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 20 max
no evidence cited — the verdict rests on absence of evidence, re-checked on refresh
Self-host the core productweight 3
3 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 30 max
- [community] https://hn.algolia.com/api/v1/items/8422408“Wish there was a plan for opensource projects, which allowed me to use customized landing page etc.”
- [community] https://hn.algolia.com/api/v1/items/32867516“Blog post titled 'From Readme to Docusaurus: How an Intern Saved Us $1.2k', describing a switch away from ReadMe.com to the open-source Docusaurus to cut costs.”
Openness = 16.2 ÷ 100 × 100 = 16.2
Built-in AI33.3/100×0.15 of the PA blend
Inside-out: how agentic the product itself is for its users — built-in assistants, autonomous features.
Get AI-generated insights and suggestions from my data inside the productweight 2
2 (weight) × 6 (quality) × 0.6 (partial) = 7.2 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/linter“You write rules in natural language — like "Use active voice" or "Flag placeholder text" — and it checks every page against them”
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Docs Audit runs your Linter rules against every page in your project in a single pass, so you can find outdated content, broken links, and style inconsistencies across your entire site”
- [claimed-docs] https://docs.readme.com/main/docs/aiagent“The Agent is a powerful documentation assistant that helps you create, edit, and enhance content across Guides, API References, Custom Pages, and more”
- [claimed-docs] https://docs.readme.com/main/docs/inline-ai“When you select text, a prompt field appears in the formatting toolbar where you can type plain-language instructions and let the Agent apply the edits.”
- [claimed-docs] https://docs.readme.com/main/docs/ai/llms.txt“Draft, edit, and research documentation from the AI chat panel.”
- [claimed-docs] https://docs.readme.com/main/docs/linter“An AI-powered tool for checking page content against your own style guide.”
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Score your entire documentation against your style guide in one run.”
- [claimed-docs] https://docs.readme.com/main/docs/using-metrics-charts“With ReadMe's API Metrics, you have reports on API call volume, endpoint usage, and errors that give you insights into your best use cases”
- [claimed-docs] https://docs.readme.com/main/docs/mcp-metrics“The MCP page in Analytics shows how many calls arrived, how quickly they returned, how many failed, and the query or endpoint behind each call.”
Set up automations that run autonomously in the backgroundweight 2
2 (weight) × 4 (quality) × 0.6 (partial) = 4.8 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/github-ai-writer“The GitHub AI Writer keeps your documentation in sync with your codebase by watching your pull requests and proposing updates when code changes affect your docs.”
- [claimed-docs] https://docs.readme.com/main/docs/reviews“Reviews allow you to check your changes for issues with the AI Linter or get approval from a teammate.”
- [claimed-docs] https://docs.readme.com/main/docs/reviews“Reviews are an optional, but highly recommended, feature to help maintain quality in your docs.”
Delegate tasks to a built-in AI assistant inside the productweight 3
3 (weight) × 6 (quality) × 0.6 (partial) = 10.8 of 30 max
- [claimed-docs] https://docs.readme.com/main/docs/aiagent“The Agent is a powerful documentation assistant that helps you create, edit, and enhance content across Guides, API References, Custom Pages, and more”
- [claimed-docs] https://docs.readme.com/main/docs/inline-ai“When you select text, a prompt field appears in the formatting toolbar where you can type plain-language instructions and let the Agent apply the edits.”
Operate the product with natural-language commandsweight 2
2 (weight) × 6 (quality) × 0.6 (partial) = 7.2 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/aiagent“The Agent is a powerful documentation assistant that helps you create, edit, and enhance content across Guides, API References, Custom Pages, and more”
- [claimed-docs] https://docs.readme.com/main/docs/inline-ai“When you select text, a prompt field appears in the formatting toolbar where you can type plain-language instructions and let the Agent apply the edits.”
- [claimed-docs] https://docs.readme.com/main/docs/linter“You write rules in natural language — like "Use active voice" or "Flag placeholder text" — and it checks every page against them”
Built-in AI = 30.0 ÷ 90 × 100 = 33.3
Automation13.0/100×0.15 of the PA blend
Depth of automation primitives — rules, scheduling, bulk operations, webhooks.
Perform bulk operations across many items at onceweight 2
2 (weight) × 4 (quality) × 0.6 (partial) = 4.8 of 20 max
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Docs Audit runs your Linter rules against every page in your project in a single pass, so you can find outdated content, broken links, and style inconsistencies across your entire site”
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Docs Audit runs your Linter rules against every page in your project in a single pass, so you can find outdated content, broken links, and style inconsistencies”
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Score your entire documentation against your style guide in one run.”
- [claimed-docs] https://docs.readme.com/main/reference/readme-api/llms.txt“Control your docs programmatically with the ReadMe API”
- [probe] https://github.com/readmeio/rdme“official CLI documented at https://github.com/readmeio/rdme”
Define rules that trigger actions automatically on eventsweight 3
3 (weight) × 0 (quality) × 0.0 (none) = 0.0 of 30 max
- [claimed-docs] https://docs.readme.com/main/docs/linter“You write rules in natural language — like "Use active voice" or "Flag placeholder text" — and it checks every page against them”
- [claimed-docs] https://docs.readme.com/main/docs/docs-audit“Docs Audit runs your Linter rules against every page in your project in a single pass, so you can find outdated content, broken links, and style inconsistencies across your entire site”
- [claimed-docs] https://docs.readme.com/main/docs/github-ai-writer“The GitHub AI Writer keeps your documentation in sync with your codebase by watching your pull requests and proposing updates when code changes affect your docs.”
- [claimed-docs] https://docs.readme.com/main/docs/bi-directional-sync“Bi-directional sync creates a two-way connection between your ReadMe project and a GitHub or GitLab repository.”
Schedule recurring jobs or workflowsweight 2
n/a — not applicable to this product: excluded from numerator and denominator
no evidence cited — the verdict rests on absence of evidence, re-checked on refresh
Version, review, and roll back my automationsweight 1
1 (weight) × 5 (quality) × 0.6 (partial) = 3.0 of 10 max
- [claimed-docs] https://docs.readme.com/main/docs/versions“Maintaining multiple versions of your documentation is critical for many different technical products.”
- [claimed-docs] https://docs.readme.com/main/docs/reviews“Reviews allow you to check your changes for issues with the AI Linter or get approval from a teammate.”
- [claimed-docs] https://docs.readme.com/main/docs/reviews“Reviews are an optional, but highly recommended, feature to help maintain quality in your docs.”
- [claimed-docs] https://docs.readme.com/main/docs/bi-directional-sync“Bi-directional sync creates a two-way connection between your ReadMe project and a GitHub or GitLab repository.”
- [claimed-docs] https://docs.readme.com/main/docs/github-ai-writer“The GitHub AI Writer keeps your documentation in sync with your codebase by watching your pull requests and proposing updates when code changes affect your docs.”
Automation = 7.8 ÷ 60 × 100 = 13.0