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 MCP Gateway for AI Agents

Expose ReadMe tools to Claude Code, Cursor, Codex, and other MCP clients through the local KosmoKrator MCP gateway.

ReadMe MCP Gateway

Expose ReadMe to MCP clients with `kosmokrator mcp:serve --integration=readme`.

If the client has never used KosmoKrator before, install it first, then register this integration as a stdio MCP server.

Install KosmoKrator

curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

Install gateway entry

kosmokrator mcp:gateway:install --integration=readme --write=deny --json

MCP configuration

{
  "mcpServers": {
    "kosmokrator-readme": {
      "type": "stdio",
      "command": "kosmo",
      "args": [
        "mcp:serve",
        "--integration=readme",
        "--write=deny"
      ]
    }
  }
}

Serve manually

kosmokrator mcp:serve --integration=readme --write=deny

Client Notes

Use one scoped MCP gateway entry, then adapt the config location to the client or framework.

Claude Code Connect local KosmoKrator integrations to Claude Code through one scoped MCP gateway entry. Claude Code can launch the local kosmo binary directly from the project MCP config.

Cursor Expose selected local integrations to Cursor through KosmoKrator without configuring each service as its own MCP server. Use the same KosmoKrator install and integration credentials that power terminal and headless runs.

Codex Use KosmoKrator as a local MCP proxy for Codex so coding sessions can reach selected integrations with explicit write policy. Keep write access denied or ask-based unless the workspace is trusted.

OpenAI Agents SDK Attach KosmoKrator integration tools to OpenAI Agents SDK workflows through a local MCP gateway. Use headless JSON commands for CI-style execution and MCP for agent tool discovery.

Claude Agent SDK Give Claude Agent SDK workflows access to KosmoKrator integrations through a local MCP server. Use a narrow integration list so the agent does not load unrelated tools.

Vercel AI SDK Use KosmoKrator as a local integration gateway for Vercel AI SDK agents and scripts. Prefer CLI JSON calls when a workflow only needs one deterministic integration operation.

LangChain Bridge LangChain agents to local KosmoKrator integration tools through MCP or headless CLI calls. Keep the gateway scoped to the integration and operation class needed by the chain.

LangGraph Run KosmoKrator integration calls from LangGraph nodes while preserving local credentials and permissions. Headless CLI calls fit repeatable graph edges; MCP fits exploratory agent nodes.

CrewAI Expose KosmoKrator integrations to CrewAI workers as scoped local tools. Use per-worker integration scopes to avoid giving every worker every tool.

Generic MCP Clients Connect any stdio-compatible MCP client to local KosmoKrator integration tools. Start with read-only write policy and expand only for trusted projects.

MCP Tool Names

KosmoKrator exposes integration tools through the gateway with stable names.

MCP tool	Source function	Type
`integration__readme__readme_get_project_metadata`	`readme.readme_get_project_metadata`	Read `read`
`integration__readme__readme_list_api_keys`	`readme.readme_list_api_keys`	Read `read`
`integration__readme__readme_list_branches`	`readme.readme_list_branches`	Read `read`
`integration__readme__readme_get_branch`	`readme.readme_get_branch`	Read `read`
`integration__readme__readme_list_categories`	`readme.readme_list_categories`	Read `read`
`integration__readme__readme_get_category`	`readme.readme_get_category`	Read `read`
`integration__readme__readme_list_category_pages`	`readme.readme_list_category_pages`	Read `read`
`integration__readme__readme_get_guide`	`readme.readme_get_guide`	Read `read`
`integration__readme__readme_get_reference`	`readme.readme_get_reference`	Read `read`
`integration__readme__readme_list_api_definitions`	`readme.readme_list_api_definitions`	Read `read`
`integration__readme__readme_get_api_definition`	`readme.readme_get_api_definition`	Read `read`
`integration__readme__readme_search_docs`	`readme.readme_search_docs`	Read `read`

Write Access

Start with --write=deny for read-only MCP clients. Use --write=ask or --write=allow only when the client and workspace are trusted.