Integration

ReadMe Dashboard integration

ReadMe is an API documentation platform that helps teams create beautiful, interactive documentation. Build developer hubs with API references, guides, changelog, and metrics. Features include OpenAPI sync, code samples, API explorer, user authentication, and analytics to understand how developers use your documentation.

Connect ReadMe Dashboard How integrations work

Ask it in chat

Say what should happen.
The workflow builds itself.

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

Common ReadMe Dashboard use cases

creating new guides
verifying API spec sync
CI/CD documentation sync
deprecating API versions
verifying API connection
displaying release history
announcing new API versions
organizing new documentation
reading documentation content
updating documentation content

What you can do with ReadMe Dashboard

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.

Doc, 4 operations

create_docCreate docPOSTCreates a new documentation page in ReadMe with Markdown content within a specified category.
delete_docDelete docDELETEPermanently deletes a documentation page from ReadMe by its slug.
get_docGet docGETRetrieves a specific documentation page from ReadMe by its URL slug, including full content and metadata.
update_docUpdate docPUTUpdates an existing documentation page in ReadMe. Can modify title, content, category, or visibility settings.

Api specification, 3 operations

delete_api_specificationDelete api specificationDELETEDeletes an API specification and all associated reference documentation from ReadMe.
get_api_specificationGet api specificationGETRetrieves a specific API specification (OpenAPI/Swagger) from ReadMe by its unique identifier.
upload_api_specificationUpload api specificationPOSTUploads an OpenAPI or Swagger specification to ReadMe to automatically generate API reference documentation.

Category, 2 operations

create_categoryCreate categoryPOSTCreates a new documentation category in ReadMe to organize content into navigable sections.
get_categoriesGet categoriesGETLists all documentation categories in the ReadMe project. Categories organize docs into navigable sections.

Changelog, 2 operations

create_changelogCreate changelogPOSTCreates a new changelog entry in ReadMe to communicate updates, releases, or changes to API consumers.
get_changelogsGet changelogsGETLists all changelog entries in the ReadMe project. Changelogs communicate product updates and releases to developers.

Project, 1 operation

get_projectGet projectGETRetrieves metadata about the current ReadMe project including name, subdomain, and configuration settings.

Use ReadMe Dashboard from Claude Code, Cursor or Codex

Connect ReadMe Dashboard in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its ReadMe Dashboard 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 Dashboard

Create your workspace
Sign up free. Nothing to install.
Connect ReadMe Dashboard once
Add your ReadMe Dashboard 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 Dashboard integration FAQ

What can you do with the ReadMe Dashboard integration?

LiveContext exposes 12 operations on ReadMe Dashboard, covering doc, api specification, category and changelog. Common uses include creating new guides, verifying API spec sync and CI/CD documentation sync.