24 actions ready for your AI

Connect ReadMe to your AI

Add your ReadMe key once and every AI you use can get changelogs, create changelogs and get custom pages through it.

Needs your API keyWorks today: paste the key from this app and your AI can use it. One-click sign-in is not built yet.

Not verified by us yet. Its actions come from ReadMe's own documented API, and we have not run them here yet.

Use your own ReadMe account. Credentials stay encrypted in ahel.

Tell me when ahel has verified ReadMe

What your AI can do with ReadMe

Choose a task and ask your AI.

Changelog

  • Get changelogsGET

    Get changelogs

    perPage
    Number of items to include in pagination (up to 100, defaults to 10)
    page
    Used to specify further pages (starts at 1)
  • Create changelogPOST

    Create changelog

    bodyrequired
    Body content of the changelog
    titlerequired
    Title of the changelog
    hidden
    Visibility of the changelog
  • Get changelogGET

    Get changelog

    slugrequired
    Slug of changelog
  • Update changelogPUT

    Update changelog

    slugrequired
    Slug of changelog
    bodyrequired
    Body content of the changelog
    titlerequired
    Title of the changelog
    hidden
    Visibility of the changelog
  • Delete changelogDELETE

    Delete changelog

    slugrequired
    Slug of changelog

Custom

  • Get custom pagesGET

    Get custom pages

    perPage
    Number of items to include in pagination (up to 100, defaults to 10)
    page
    Used to specify further pages (starts at 1)
  • Create custom pagePOST

    Create custom page

    titlerequired
    Title of the custom page
    body
    Body formatted in Markdown (displayed by default).
    hidden
    Visibility of the custom page
    html
    Body formatted in HTML (sanitized, only displayed if htmlmode is true).
  • Get custom pageGET

    Get custom page

    slugrequired
    Slug of custom page
  • Update custom pagePUT

    Update custom page

    slugrequired
    Slug of custom page
    titlerequired
    Title of the custom page
    body
    Body formatted in Markdown (displayed by default).
    hidden
    Visibility of the custom page
  • Delete custom pageDELETE

    Delete custom page

    slugrequired
    Slug of custom page

Doc

  • Create docPOST

    Create doc

    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
    categoryrequired
    Category ID of the page, which you can get through https://docs.readme.com/developers/reference/categories#getcategory
    titlerequired
    Title of the page
    body
    Body content of the page, formatted in ReadMe or Github flavored Markdown.
  • Search docsPOST

    Search docs

    searchrequired
    Search string to look for
    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
  • Get docGET

    Get doc

    slugrequired
    Slug of doc.
    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
  • Update docPUT

    Update doc

    slugrequired
    Slug of doc.
    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
    categoryrequired
    Category ID of the page, which you can get through https://docs.readme.com/developers/reference/categories#getcategory
    titlerequired
    Title of the page

Version

  • Get versionsGET

    Get versions

  • Create versionPOST

    Create version

    fromrequired
    Semantic Version to use as the base fork
    versionrequired
    Semantic Version
    codename
    Dubbed name of version
    is_deprecated
    Should this be deprecated? Only allowed in PUT operations
  • Get versionGET

    Get version

    versionIdrequired
    Semver version indentifier
  • Update versionPUT

    Update version

    versionIdrequired
    Semver version indentifier
    fromrequired
    Semantic Version to use as the base fork
    versionrequired
    Semantic Version
    codename
    Dubbed name of version
Show 4 more groups

Apispecification

  • Get apispecificationGET

    Get API specification metadata

    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
    perPage
    Number of items to include in pagination (up to 100, defaults to 10)
    page
    Used to specify further pages (starts at 1)
  • Upload apispecificationPOST

    Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/automatically-sync-api-specification-with-github

    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
    spec
    OpenAPI/Swagger file

Category

  • Get category docsGET

    Get docs for category

    slugrequired
    Slug of category.
    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.
  • Get categoryGET

    Get category

    slugrequired
    Slug of category.
    x-readme-versionrequired
    Version number of your docs project, for example, v3.0.

Error

  • Get errorsGET

    Get errors

Project

  • Get projectGET

    Get metadata about the current project

Ask your AI

Try one of these requests with a connected AI.

  • Show me the changelog in ReadMe
  • Create a changelog in ReadMe
  • Show me the custom page in ReadMe
  • Create a custom page in ReadMe
  • Create a doc in ReadMe
  • Show me the version in ReadMe

Published servers for ReadMe

Built by the community and served through your gateway with the same key. A curated pick is one ahel has checked.

ReadMe MCP server, hosted by ahel

One hosted endpoint serves ReadMe. There is nothing to install and no local server to run.

Connect ReadMe to Claude, Claude Code, Cursor or Codex

  1. Add your ReadMe key. ahel stores it encrypted.
  2. Paste one link into your AI: https://mcp.ahel.ai (once, for every app).
  3. Ask for the work. Your AI picks the action and ahel runs it with your key.

Documentation

About ReadMe

ReadMe is a developer tools service. Connect your own key and your AI can get changelogs, create changelogs and get custom pages.

ReadMe over MCP: ahel serves ReadMe to Claude, Claude Code, Cursor and Codex as one hosted MCP endpoint. There is no local server to run. Add your ReadMe key once, paste one link into your AI, and the actions above are there.

Developer tools

Questions

Is my ReadMe key safe?

Your ReadMe key is sealed in ahel and added to the request server-side when your AI calls ReadMe. It never crosses the MCP link, no tool can read it back, and you can turn the app off or remove the key at any time.

Which AIs can use ReadMe through ahel?

Any MCP-capable AI: Claude, Claude Code, Codex, Cursor, VS Code and others. Paste one link, https://mcp.ahel.ai, into the AI once and everything in your gateway arrives through it.

What can my AI do with ReadMe?

24 actions today, covering changelogs, customs and docs. Ask in plain language; your AI picks the action and ahel runs it with your key.

Does connecting ReadMe cost anything?

Connecting apps is free during ahel's early access. Free, Pro and Team all cost nothing today, and the pricing page lists what each one includes. ReadMe may bill you for API use under its own terms.