Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
ReadMe website screenshot

ReadMe

ReadMe is a developer hub platform that helps companies design, document, and operate their APIs. The platform combines hosted API reference (OpenAPI-driven), guides and changelog, bi-directional Git sync (GitHub and GitLab), interactive API explorer, Try-It console, Developer Dashboard with real-time API logs, and a deep layer of AI tooling — including the ReadMe Agent for multi-page editing, Inline AI rewrites, the AI Linter for style-guide enforcement, Docs Audit, GitHub AI Writer for PR-triggered doc updates, Ask AI for end users, and Model Context Protocol (MCP) servers for both ReadMe itself and each customer project so AI tools can search, read, update docs, and call APIs.

agent ready

Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.

Kin Score

API Evangelist profiles ReadMe the way a machine reads it — 51 machine-readable artifacts across 14 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.

Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — ReadMe scores 68.4/100 (strong), with a separate agent-readiness read of 54/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.

Kin Score

This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.

Kin Score Kin Score How this is scored →
scored 2026-07-27 · rubric v0.5
Composite quality — 68.4/100 · strong
Contract Quality 16.6 / 25
Developer Ergonomics 13.0 / 20
Commercial Clarity 16.8 / 20
Operational Transparency 7.5 / 13
Governance 5.7 / 12
Discoverability 8.8 / 10
Agent readiness — 54/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 15 / 15
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3

How we profile ReadMe

Each block below is one kind of artifact we hold for ReadMe. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.

APIs 14

Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.

Individual APIs this provider publishes, each with its own machine-readable definition.

ReadMe MCP Server

ReadMe operates a hosted Model Context Protocol (MCP) server that lets AI tools (Claude, Cursor, IDEs, CI pipelines) search, read, and update ReadMe documentation through natura...

ReadMe Personalized Docs Webhook

ReadMe's Personalized Docs Webhook is the outbound, customer-hosted webhook the developer hub calls at user sign-in to look up a reader's account data. ReadMe POSTs a JSON body ...

ReadMe Analytics API

Page view, quality, and search analytics

ReadMe API Keys API

Manage ReadMe API keys

ReadMe APIs API

Manage API definitions and reference pages

ReadMe Branches API

Manage versions and branches

ReadMe Categories API

Manage sidebar groupings

ReadMe Changelog API

Manage changelog posts

ReadMe Custom Pages API

Manage custom documentation pages

ReadMe Guides API

Manage knowledge base guide pages

ReadMe Images API

Upload and manage images

ReadMe Metrics API

Send API request metrics from server-side SDKs

ReadMe Recipes API

Manage interactive recipe content

ReadMe Search API

Search knowledge base content

Scroll within the panel for all 14 ·

Open Collections 2

Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

ReadMe API

OPEN COLLECTION

Arazzo Workflows 12

Real integrations are rarely a single call. Arazzo describes the multi-step sequences — auth, then create, then confirm — so both a human and an agent can follow the choreography, not just the endpoints.

Multi-step API workflows described with the Arazzo specification.

ReadMe Stand Up A New Version With Starter Docs

Create a branch (version), add a category, and seed it with a first guide.

ARAZZO

ReadMe Create A Category With A Guide

Create a sidebar category and immediately add a guide page to it.

ARAZZO

ReadMe Publish A Changelog Post

Create a changelog post on a branch and read it back by slug.

ARAZZO

ReadMe Publish A Custom Page

Create a custom page on a branch and read it back by slug.

ARAZZO

ReadMe Publish A Recipe

Create an interactive recipe and read it back by slug.

ARAZZO

ReadMe Cut A Version And Announce It

Create a branch, upload its API definition, and post a launch changelog.

ARAZZO

ReadMe Submit Metrics And Audit Quality

Send API request logs to Metrics, then retrieve page quality scores.

ARAZZO

ReadMe Upload An API Definition And Verify

Upload an OpenAPI definition to a branch and read the created definition back.

ARAZZO

ReadMe Upsert A Category

Find a category by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Changelog Post

Find a changelog post by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Custom Page

Find a custom page by slug and update it if it exists, otherwise create it.

ARAZZO

ReadMe Upsert A Guide Page

Find a guide by slug and update it if it exists, otherwise create it.

ARAZZO

Scroll within the panel for all 12 ·

GraphQL 1

Where a provider ships GraphQL, the schema is the contract. We profile it alongside the REST surface so the whole interface is legible in one place.

GraphQL schemas published by this provider.

Pricing Plans 1

Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.

Published pricing tiers and plan structures.

Readme Plans Pricing

3 plans

PLANS

Rate Limits 1

Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.

Documented rate limits and quota policies.

Readme Rate Limits

2 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.

Cost, billing, and metering signals for API financial operations.

Event Specifications 1

Not every API is request/response. AsyncAPI describes the event-driven and streaming side — the webhooks and channels — so the asynchronous half of the interface is documented the same way the synchronous half is.

AsyncAPI definitions for this provider's event-driven and streaming APIs.

ReadMe Personalized Docs Webhook

AsyncAPI 2.6 description of ReadMe's Personalized Docs Webhook surface. The Personalized Docs Webhook is the integration that lets ReadMe inject a logged-in end user's account d...

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.

JSON-LD contexts and semantic vocabularies used across these APIs.

Readme Context

35 classes · 0 properties

JSON-LD

Spectral Rules 3

Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.

ReadMe API Rules

3 rules · 1 errors · 1 warnings

SPECTRAL

ReadMe API Rules

5 rules · 3 warnings

SPECTRAL

ReadMe API Rules

9 rules · 5 errors · 4 warnings

SPECTRAL

JSON Schema 5

Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.

Standalone JSON Schema definitions for this provider's data models.

ReadMe API Definition

9 properties

JSON SCHEMA

ReadMe Branch

8 properties

JSON SCHEMA

ReadMe Changelog Post

8 properties

JSON SCHEMA

ReadMe Guide

11 properties

JSON SCHEMA

ReadMe Metrics Request Log

6 properties

JSON SCHEMA

JSON Structure 1

JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.

JSON Structure definitions describing this provider's data shapes.

Readme Developer Hub Structure

0 properties

JSON STRUCTURE

Examples 5

Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.

Example request and response payloads for these APIs.

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Readme Authentication

http · 2 schemes

SECURITY

Readme Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.

Recommended x-agentic-access execution contracts for AI agents.

Readme Agentic Access

44 operations · 25 acting

44 operations · 25 acting

AGENTIC

Resources

Every other property we hold for ReadMe — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.

Get Started 4

Portal, sign-up, and the first successful call

Documentation 2

Reference material describing how the API behaves

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

Access & Security 2

Authentication, authorization, and security posture

Operate 3

Status, limits, changes, and where to get help

Company 3

The organization behind the API

Other 1

Properties that don't map to a standard resource type

← All providers · Data indexed from github.com/api-evangelist/readme · machine-readable index on apis.io