Integration

ReadMe integration

ReadMe is a developer documentation platform that enables teams to create beautiful, interactive API documentation. Build API references from OpenAPI specs, create guides and tutorials, manage changelogs, and provide developer hubs with interactive 'Try It' functionality. Features include version control, custom branding, analytics, and integrations with CI/CD pipelines for automated doc updates.

Connect ReadMe How integrations work

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in ReadMe.Built from the 27 ReadMe tools below, on the connection you add once.

Common ReadMe use cases

generating site maps
reorganizing documentation
CI/CD spec validation
creating landing pages
announcing new features
auditing custom content
uploading new API specs
building custom search UI
displaying changelog feed
removing empty categories

What you can do with ReadMe

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Branch, 5 operations

create_branchCreate branchPOSTCreates a new documentation version branch. Optionally fork content from an existing branch to inherit all pages, categories, and API definitions. Configure visibility (public, hidden, deprecated) and whether it becomes the main branch.
delete_branchDelete branchDELETEPermanently deletes a documentation version branch and ALL associated content. This removes all docs, categories, API definitions, and custom pages within the branch. Cannot be undone.
get_branchGet branchGETRetrieves details about a specific documentation branch. Returns branch name, visibility settings, creation date, and whether it's the main branch. Use before performing operations on a specific version.
list_branchesList branchesGETLists all version branches in your ReadMe project. Returns branch names, visibility settings, and whether each is the main branch. Use this to discover available documentation versions before querying docs, categories, or APIs within a specific br...
update_branchUpdate branchPATCHUpdates configuration for a documentation version branch. Change visibility settings, mark as deprecated, or set as the main branch. Only the fields you include will be modified.

Changelog, 5 operations

create_changelogCreate changelogPOSTCreates a new changelog entry. Specify title, Markdown content, and entry type (added, improved, fixed, deprecated, removed). Optionally hide the entry until ready to publish.
delete_changelogDelete changelogDELETEPermanently deletes a changelog entry. The entry is removed from the changelog feed and its URL becomes unavailable. Cannot be undone.
get_changelogGet changelogGETRetrieves a single changelog entry by ID or slug. Returns full content, metadata, publication date, and type classification. Use to read entry details or prepare updates.
list_changelogsList changelogsGETLists all changelog entries in your documentation project. Changelogs are global (not version-specific) and document product updates, releases, and announcements. Returns titles, dates, types, and content previews.
update_changelogUpdate changelogPUTUpdates an existing changelog entry. Modify title, content, type classification, or visibility. Only included fields are changed; others remain unchanged.

Guide, 5 operations

create_guideCreate guidePOSTCreates a new documentation guide page. Provide title, category, and Markdown/HTML content. Optionally set visibility (hidden) and sort order within the category.
delete_guideDelete guideDELETEPermanently deletes a documentation guide page. This removes the page from navigation and makes its URL unavailable. Cannot be undone through the API.
get_guideGet guideGETRetrieves a single documentation page by its slug. Returns full content, metadata, category, visibility status, and revision information. Use to read existing content or prepare for updates.
list_guidesList guidesGETLists all guide documentation pages in a version branch. Returns page titles, slugs, categories, and metadata. Use this to discover existing documentation or audit content.
update_guideUpdate guidePATCHUpdates an existing documentation page. Modify title, content, category assignment, visibility, or sort order. Only included fields are updated; others remain unchanged.

Category, 4 operations

create_categoryCreate categoryPOSTCreates a new category in a documentation branch. Categories are sidebar headings that group related docs or API reference pages. Specify the section (guides or reference) and optional sort order.
delete_categoryDelete categoryDELETEDeletes a category from the documentation. The category must be empty (no pages) before deletion. Move or delete all pages within the category first.
list_categoriesList categoriesGETLists all categories within a documentation branch for either guides or API reference sections. Categories are the top-level groupings in the sidebar navigation. Returns category titles, slugs, and ordering information.
update_categoryUpdate categoryPATCHUpdates an existing category's title or sort order. Renaming a category automatically updates its slug and all page references. Changes are immediately reflected in the documentation sidebar.

Custom page, 2 operations

create_custom_pageCreate custom pagePOSTCreates a new custom page. Provide content as Markdown (body) or HTML (html). Custom pages are standalone and don't appear in category navigation.
list_custom_pagesList custom pagesGETLists all custom pages in a version branch. Custom pages are standalone pages outside the standard documentation hierarchy, useful for landing pages, terms of service, or special content.

Api definition, 1 operation

upload_api_definitionUpload api definitionPOSTUploads an API definition (OpenAPI 3.0/3.1 or Swagger 2.0) to generate interactive API reference documentation. The spec can be JSON or YAML format. Automatically generates the API reference pages.

Apis, 1 operation

list_api_definitionsList api definitionsGETLists all API definitions (OpenAPI/Swagger specs) in a version branch. Returns filenames, titles, and metadata for each uploaded specification that powers the API reference.

Doc, 1 operation

search_docsSearch docsGETSearches across all documentation content. Returns matching pages with relevance scores, snippets, and direct links. Optionally limit search to a specific version branch.

Image, 1 operation

upload_imageUpload imagePOSTUploads an image file to ReadMe's CDN for use in documentation. Returns the hosted URL to embed in docs, custom pages, or project branding. Supports PNG, JPG, GIF, and SVG formats.

Project, 1 operation

get_projectGet projectGETGets metadata about your ReadMe documentation project. Returns project name, subdomain, plan type, JWT secret, and base URL. Essential for verifying API key access and retrieving project configuration before performing other operations.

Validate, 1 operation

validate_api_definitionValidate api definitionPOSTValidates an API specification without uploading it. Returns errors, warnings, and compatibility information. Use to check specs before deployment.

Use ReadMe from Claude Code, Cursor or Codex

Connect ReadMe in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its ReadMe operations become tools the client can call, next to every other integration you connected.

Claude Code

claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"

Codex (~/.codex/config.toml)

[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"

Cursor, Claude Desktop and other JSON configs

{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect ReadMe

Create your workspace
Sign up free. Nothing to install.
Connect ReadMe once
Add your ReadMe connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.

ReadMe integration FAQ

What can you do with the ReadMe integration?

LiveContext exposes 27 operations on ReadMe, covering branch, changelog, guide and category. Common uses include generating site maps, reorganizing documentation and CI/CD spec validation.