Can I use ReadMe as a CLI?

Yes. KosmoKrator exposes a ReadMe CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose ReadMe through MCP?

Yes. The KosmoKrator MCP gateway can expose selected ReadMe tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are ReadMe credentials stored?

ReadMe credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for ReadMe MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

ReadMe CLI for AI Agents

Use the ReadMe CLI from KosmoKrator to call ReadMe tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

ReadMe CLI Setup

ReadMe can be configured headlessly with `kosmokrator integrations:configure readme`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure readme --set api_token="$README_API_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor readme --json
kosmokrator integrations:status --json

Credentials

Authentication type: API token api_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_token`	`README_API_TOKEN`	Secret `secret`	yes	API Token

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call readme.readme_get_project_metadata '{}' --json

Provider shortcut

kosmo integrations:readme readme_get_project_metadata '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs readme --json
kosmo integrations:docs readme.readme_get_project_metadata --json
kosmo integrations:schema readme.readme_get_project_metadata --json
kosmo integrations:search "ReadMe" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`readme.readme_get_project_metadata`

Get metadata for the current ReadMe project.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_get_project_metadata '{}' --json

Shortcut

kosmo integrations:readme readme_get_project_metadata '{}' --json

`readme.readme_list_api_keys`

List API keys for a project subdomain.

Read read

Parameters: subdomain

Generic call

kosmo integrations:call readme.readme_list_api_keys '{"subdomain":"example_subdomain"}' --json

Shortcut

kosmo integrations:readme readme_list_api_keys '{"subdomain":"example_subdomain"}' --json

`readme.readme_list_branches`

List ReadMe branches.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_list_branches '{}' --json

Shortcut

kosmo integrations:readme readme_list_branches '{}' --json

`readme.readme_get_branch`

Get one ReadMe branch.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_get_branch '{}' --json

Shortcut

kosmo integrations:readme readme_get_branch '{}' --json

`readme.readme_list_categories`

List categories in a branch section.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_list_categories '{}' --json

Shortcut

kosmo integrations:readme readme_list_categories '{}' --json

`readme.readme_get_category`

Get one category in a branch section.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_get_category '{}' --json

Shortcut

kosmo integrations:readme readme_get_category '{}' --json

`readme.readme_list_category_pages`

List pages within a category.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_list_category_pages '{}' --json

Shortcut

kosmo integrations:readme readme_list_category_pages '{}' --json

`readme.readme_get_guide`

Get a guide page by slug.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_get_guide '{}' --json

Shortcut

kosmo integrations:readme readme_get_guide '{}' --json

`readme.readme_get_reference`

Get an API reference page by slug.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_get_reference '{}' --json

Shortcut

kosmo integrations:readme readme_get_reference '{}' --json

`readme.readme_list_api_definitions`

List API definitions.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_list_api_definitions '{}' --json

Shortcut

kosmo integrations:readme readme_list_api_definitions '{}' --json

`readme.readme_get_api_definition`

Get one API definition.

Read read

Parameters: api_id

Generic call

kosmo integrations:call readme.readme_get_api_definition '{"api_id":"example_api_id"}' --json

Shortcut

kosmo integrations:readme readme_get_api_definition '{"api_id":"example_api_id"}' --json

`readme.readme_search_docs`

Search ReadMe docs using the documented legacy search endpoint.

Read read

Parameters: none

Generic call

kosmo integrations:call readme.readme_search_docs '{}' --json

Shortcut

kosmo integrations:readme readme_search_docs '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

readme.readme_get_project_metadata 0 parameters

Schema command

kosmo integrations:schema readme.readme_get_project_metadata --json

Parameter	Type	Required	Description
No parameters.

readme.readme_list_api_keys 1 parameters

Schema command

kosmo integrations:schema readme.readme_list_api_keys --json

Parameter	Type	Required	Description
`subdomain`	string	yes	ReadMe project subdomain.

readme.readme_list_branches 0 parameters

Schema command

kosmo integrations:schema readme.readme_list_branches --json

Parameter	Type	Required	Description
No parameters.

readme.readme_get_branch 0 parameters

Schema command

kosmo integrations:schema readme.readme_get_branch --json

Parameter	Type	Required	Description
No parameters.

readme.readme_list_categories 0 parameters

Schema command

kosmo integrations:schema readme.readme_list_categories --json

Parameter	Type	Required	Description
No parameters.

readme.readme_get_category 0 parameters

Schema command

kosmo integrations:schema readme.readme_get_category --json

Parameter	Type	Required	Description
No parameters.

readme.readme_list_category_pages 0 parameters

Schema command

kosmo integrations:schema readme.readme_list_category_pages --json

Parameter	Type	Required	Description
No parameters.

readme.readme_get_guide 0 parameters

Schema command

kosmo integrations:schema readme.readme_get_guide --json

Parameter	Type	Required	Description
No parameters.

readme.readme_get_reference 0 parameters

Schema command

kosmo integrations:schema readme.readme_get_reference --json

Parameter	Type	Required	Description
No parameters.

readme.readme_list_api_definitions 0 parameters

Schema command

kosmo integrations:schema readme.readme_list_api_definitions --json

Parameter	Type	Required	Description
No parameters.

readme.readme_get_api_definition 1 parameters

Schema command

kosmo integrations:schema readme.readme_get_api_definition --json

Parameter	Type	Required	Description
`api_id`	string	yes	ReadMe API definition ID.

readme.readme_search_docs 0 parameters

Schema command

kosmo integrations:schema readme.readme_search_docs --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.