ReadMe MCP integration for AI agents.
Connect AI agents to ReadMe through 33 structured actions, including get api registry, create category, delete api specification, and ask owlbot. Review auth…
- ACTION CONTRACTS
- 33
- AUTHENTICATION
- API key
- SOURCE STATUS
- Provider-backed
CATALOG SOURCE REVIEWED AUGUST 23, 2026 / ACTION NAMES AND SCHEMAS DERIVED FROM WORKING MACHINES PROVIDER SOURCE
CAPABILITY PROFILE
What the ReadMe integration exposes
The ReadMe Agent App exposes 33 provider-backed actions for developer tools and productivity work. Its current contract lets an authorized agent retrieve one readme api registry entry by uuid, create a readme guide or reference category, and delete one readme api specification by id. These operations are called through Working Machines as typed capabilities rather than through browser navigation or copied UI steps.
A connection uses API key. Before execution, the agent can inspect the selected action, its required fields, declared scopes, and expected output contract. Provider credentials remain inside the Working Machines runtime; the calling agent receives the capability and its structured result, not the underlying secret.
For reliable operation, start with the narrowest action that satisfies the task, resolve stable provider identifiers before changing state, and validate the returned object or status after execution. Availability still depends on the connected ReadMe account, granted provider permissions, workspace policy, region, plan, and upstream API behavior.
VERIFIED ACTION SAMPLE
Real ReadMe capabilities.
Showing 12 of 33 actions. Risk labels are conservative signals based on operation names, not substitutes for provider documentation or runtime policy.
get_api_registryREADRetrieve one ReadMe API Registry entry by UUID.
INPUTS: uuid
create_categoryWRITECreate a ReadMe guide or reference category.
INPUTS: version / title / type
delete_api_specificationHIGH IMPACTDelete one ReadMe API specification by ID.
INPUTS: id
ask_owlbotREVIEWAsk ReadMe Owlbot a non-streaming question and return its answer with sources.
INPUTS: question
create_changelogWRITECreate a ReadMe changelog entry.
INPUTS: title / type / body / hidden
create_custom_pageWRITECreate a ReadMe custom page.
INPUTS: title / body / html / htmlmode / hidden
create_docWRITECreate a ReadMe doc page using a category ID or category slug.
INPUTS: version / title / type / body / category
create_versionWRITECreate a new ReadMe project version from an existing base version.
INPUTS: version / codename / from / is_stable / is_beta
delete_categoryHIGH IMPACTDelete one ReadMe category by slug.
INPUTS: slug / version
delete_changelogHIGH IMPACTDelete one ReadMe changelog entry by slug.
INPUTS: slug
delete_custom_pageHIGH IMPACTDelete one ReadMe custom page by slug.
INPUTS: slug
delete_docHIGH IMPACTDelete one ReadMe doc page by slug.
INPUTS: slug / version
INPUT CONTRACTS
Know what the action needs before it runs.
get_api_registry
uuidOPTIONAL- The API Registry UUID to retrieve from ReadMe.
create_category
versionOPTIONAL- The optional ReadMe project version to send with the x-readme-version header, for example v3.0.
titleREQUIRED- A short title for the category.
typeOPTIONAL- The ReadMe category type.
delete_api_specification
idOPTIONAL- The API specification ID to delete.
ask_owlbot
questionOPTIONAL- The question to ask Owlbot.
PROVIDER-SPECIFIC WORKFLOWS
Jobs this Agent App can support
Inspect Get Api Registry
Retrieve one ReadMe API Registry entry by UUID. Use this as a bounded discovery step, retain the returned identifier, and avoid expanding the read beyond the task's stated scope.
get_api_registryControl Create Category
Create a ReadMe guide or reference category. Resolve the target first, present material changes for confirmation, and make retries idempotent where the provider supports it.
create_categoryVerify with Create Category
Create a ReadMe guide or reference category. Compare the returned provider state with the intended outcome and preserve stable IDs or canonical links in the run record.
create_categorySAFETY BOUNDARY
Operate ReadMe with explicit limits
- Authorize ReadMe with API key and grant only the provider access required by the selected actions.
- 16 actions are change-capable by name. Confirm the target identity and material parameters before allowing a write.
- Treat `delete_api_specification`, `delete_category`, and `delete_changelog` as high-impact operations and require an explicit approval boundary.
- No provider scope string is declared on the sampled actions. Verify the connected account's actual permissions in ReadMe rather than assuming unrestricted access.
- After a call, inspect the structured result and execution record before reporting that the ReadMe task completed successfully.
CONNECTION MODEL
API key
ReadMe API key sent with HTTP Basic authentication. Create or rotate keys from the API Keys page in your ReadMe dashboard.
Working Machines stores provider credentials behind the execution boundary. An agent can use an authorized connection identity, but catalog discovery alone does not reveal OAuth tokens, API keys, or provider secrets.
- READ SIGNALS
- 16
- WRITE SIGNALS
- 10
- HIGH IMPACT
- 6
- REVIEW SIGNALS
- 1
EVIDENCE AND AVAILABILITY
Provider reference
Action names, input fields, authentication types, and counts on this page are generated from the Working Machines provider catalog. Provider behavior, quotas, object semantics, account eligibility, and regional availability remain governed by ReadMe.