Getting started as a client
Tool overview (server mode)
Themeerkat-mcp-server crate exposes Meerkat as MCP tools that other clients can call.
meerkat_run and meerkat_resume keep the same public MCP tool contract, but
their execution path is runtime-backed: meerkat_run allocates a session
through the shared session service and waits for that admitted turn to finish,
and meerkat_resume re-enters the same session_id instead of starting a
second surface-local execution loop.
| Tool | Description |
|---|---|
meerkat_run | Start a new agent session |
meerkat_resume | Continue a session or provide tool results |
meerkat_read | Read a session’s state |
meerkat_history | Read a session’s committed transcript history |
meerkat_sessions | List sessions in the active realm |
meerkat_interrupt | Interrupt an in-flight turn |
meerkat_archive | Archive (remove) a session |
meerkat_config | Get or update server config |
meerkat_capabilities | Query runtime capabilities |
meerkat_models_catalog | List available models with provider profiles and capabilities |
meerkat_skills | List or inspect available skills |
meerkat_mcp_add | Stage a live MCP server addition on an active session |
meerkat_mcp_remove | Stage a live MCP server removal on an active session |
meerkat_mcp_reload | Stage a live MCP server reload on an active session |
meerkat_event_stream_open | Open a session-level agent event stream |
meerkat_event_stream_read | Read the next item from an open event stream |
meerkat_event_stream_close | Close a previously opened event stream |
meerkat_mob_prefabs | List built-in mob prefab templates (mob feature) |
meerkat_mob_event_stream_open | Open a mob-level event stream (mob feature) |
meerkat_mob_event_stream_read | Read the next event from an open mob stream (mob feature) |
meerkat_mob_event_stream_close | Close a previously opened mob event stream (mob feature) |
meerkat_comms_send | Send a canonical comms command to a session (comms feature) |
meerkat_comms_peers | List peers visible to a session (comms feature) |
When the
mob feature is enabled, meerkat-mob-mcp mob lifecycle tools (e.g.
mob_create, mob_list, mob_lifecycle) are also exposed alongside the
meerkat_* tools listed above. Additionally, mob capability within sessions is
provided by composing MobMcpDispatcher into SessionBuildOptions.external_tools
used by meerkat_run/meerkat_resume.Use MCP servers as tools (client)
CLI configuration (recommended)
Use therkat mcp commands to manage MCP servers:
Config file format
MCP servers are stored in TOML in two scopes:- Project:
.rkat/mcp.toml - User:
~/.rkat/mcp.toml
Config file examples
Config file examples
Supported transports: stdio, streamable HTTP (default for URLs), and SSE.
Environment variables in config use
${VAR_NAME} syntax.Meerkat as an MCP server
Connecting other clients
You can connect any MCP-capable client to a Meerkat MCP server. Run a server process that exposes themeerkat_* tools (stdio or HTTP), then point the client at it.
- Claude Code
- Codex CLI
- Gemini CLI
Claude Code reads MCP servers from a
.mcp.json file in your project root.
Example stdio config:Hosting the MCP server
meerkat-mcp-server is a library crate that provides tool schemas and handlers. If you need a standalone MCP server process, add a thin binary wrapper around its tools_list() and handle_tools_call* entrypoints, or embed it in an existing MCP host.
The bundled rkat-mcp binary supports realm scope flags:
--realm is omitted, the server creates a new isolated realm by default.
--realm-backend is a creation hint only; after the first open, the manifest-pinned backend is authoritative.
Tool reference
meerkat_run
Start a new Meerkat agent session with the given prompt.Parameter reference
User prompt for the agent.
Override system prompt.
Model name (e.g.
"claude-opus-4-6", "gpt-5.2").Max tokens per turn.
Provider:
"anthropic", "openai", "gemini", "other".JSON schema for structured output (wrapper or raw schema).
Max retries for structured output validation. Omit /
null to use the product default on run or inherit the persisted session value on resume.Stream agent events via MCP notifications.
Enable verbose event logging (server-side).
Tool definitions for the agent (see McpToolDef schema below).
Builtins override. Omit /
null to use the default on run or inherit the persisted session value on resume.Config for builtins (only used when
enable_builtins is true).Shell-tools override. Omit /
null to use the default on run or inherit the persisted session value on resume.Default shell command timeout.
Keep session alive after turn for comms. On
meerkat_run, null/omitted uses the run default (false), true enables, and false explicitly disables. Requires comms_name when enabled.Agent name for comms.
Run-scoped hook overrides.
McpToolDef schema
Tool name.
Tool description.
JSON Schema for tool input.
Handler type (
"callback" = result provided via meerkat_resume).handler: "callback" are provided and the agent requests a tool call, the response includes pending_tool_calls. The MCP client must execute the tool and provide results via meerkat_resume.
meerkat_resume
Resume an existing runtime-backed session or provide tool results for pending tool calls. The call waits for the resumed turn to complete and returns the samesession_id that meerkat_run originally materialized.
Parameter reference
Session ID to resume.
Follow-up prompt (can be empty when providing tool results).
Stream agent events via MCP notifications.
Enable verbose event logging.
Tool definitions (should match the original run).
Tool results for pending tool calls.
ID of the tool call.
Result content (or error message).
Whether this is an error result.
Builtins override. Omit /
null to inherit the persisted session value.Builtin tool config.
Shell-tools override. Omit /
null to inherit the persisted session value.Keep-alive override for this resume.
null = inherit persisted session intent, true = enable, false = disable.meerkat_run and meerkat_resume follow the same commit/cancel rule as the other interactive surfaces: committed success is not rewritten to cancellation, and post-commit create failure returns session identity so the session can be resumed.Agent name for comms.
Model override. On materialized sessions this hot-swaps the LLM client for the remainder of the session.
Max tokens override.
Provider override. Typically inferred from
model. Used with model for mid-session provider switching.Run-scoped hook overrides.
Response format
Bothmeerkat_run and meerkat_resume return MCP-standard tool results. The inner text field is a JSON-encoded payload containing:
MCP content blocks with the agent’s text.
Session ID (save for
meerkat_resume).Number of LLM calls made.
Number of tool calls executed.
Parsed structured output.
Schema compatibility warnings.
meerkat_config
Get or update realm config for this MCP server instance.One of
"get", "set", "patch".Full config to replace (for
set action).RFC 7396 merge-patch delta (for
patch action).Optional optimistic concurrency check for
set and patch.configgenerationrealm_idinstance_idbackendresolved_paths
meerkat_capabilities
Returns the runtime capability set with status resolved against config.status values:
| Status | Shape | Meaning |
|---|---|---|
Available | "Available" | Compiled in, config-enabled |
DisabledByPolicy | {"DisabledByPolicy": {"description": "..."}} | Compiled in but disabled |
NotCompiled | {"NotCompiled": {"feature": "..."}} | Feature flag absent |
NotSupportedByProtocol | {"NotSupportedByProtocol": {"reason": "..."}} | Protocol does not support it |
meerkat_models_catalog
Return the curated model catalog with provider profiles, capability metadata, and parameter schemas.meerkat-models at build time.
meerkat_skills
List or inspect available skills with provenance information."list" to list all skills, "inspect" to inspect a specific skill.Skill ID to inspect (required when
action is "inspect").is_active: false and a shadowed_by field indicating which source has precedence.