KosmoKrator

productivity

ReadMe MCP, CLI, and Lua Integration for AI Agents

ReadMe integration docs for AI agents: MCP gateway setup, ReadMe CLI commands, Lua API reference, credentials, and function schemas.

ReadMe for agents

Credentials can be configured manually in web or CLI hosts.

Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.

Agent Surfaces

ReadMe CLIHeadless setup, JSON output, direct function calls. ReadMe MCPExpose selected tools to local MCP clients. ReadMe LuaAgent-facing namespace and Lua reference. FeedbackReport missing tools, auth issues, or bad metadata.

Machine-Readable Metadata

integration_slug
readme
route_slug
readme
package
readme
auth_strategy
api_token
cli_setup_supported
true
cli_runtime_supported
true
mcp_gateway_supported
true
lua_supported
true

Function Catalog

FunctionTypeParametersDescription
readme.readme_get_project_metadata Read read 0 Get metadata for the current ReadMe project.
readme.readme_list_api_keys Read read 1 List API keys for a project subdomain.
readme.readme_list_branches Read read 0 List ReadMe branches.
readme.readme_get_branch Read read 0 Get one ReadMe branch.
readme.readme_list_categories Read read 0 List categories in a branch section.
readme.readme_get_category Read read 0 Get one category in a branch section.
readme.readme_list_category_pages Read read 0 List pages within a category.
readme.readme_get_guide Read read 0 Get a guide page by slug.
readme.readme_get_reference Read read 0 Get an API reference page by slug.
readme.readme_list_api_definitions Read read 0 List API definitions.
readme.readme_get_api_definition Read read 1 Get one API definition.
readme.readme_search_docs Read read 0 Search ReadMe docs using the documented legacy search endpoint.