MCPconceptAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

MCP: API Reference

Edit this page on GitHub

C++ MCP API

mcp_tools consumer 0.1.0 · Source

For MCP client requests, use the tool reference. This page covers language APIs for embedding or extending the server.

The installed product is libtmux-mcp-server. Its public MCP operations are available through the protocol. The C++ tool model lives in a source consumer and is not exported by the installed core package.

Consumer API

libtmux::mcp::default_tools() returns an expected value containing a ToolRegistry or an error. tools() enumerates definitions, find() looks up a name, and call() invokes a handler against a Server with named arguments and an optional CallContext.

ToolResult is an expected value containing structured output or a ToolError. CallContext provides cooperative cancellation and progress callbacks. ToolDefinition describes parameters, output shape, and effect annotations independently of a JSON library.

Consumer declarations and build target.

Protocol API

The tool reference covers registered names and schemas. Toolsets and exact names filter the catalog at startup. The static tmux://capabilities resource reports that selection. The server has no workflow prompts or dynamic resource templates.

Successful tool calls return matching structured content and serialized JSON text. Strict argument validation precedes tmux execution. Protocol tests cover supported lifecycle revisions and result shapes.

Workspace builder API documents a separate source consumer; it is not a workspace operation in this MCP catalog.

API declarations

Follow a declaration for its signature, members, documentation, and source.

Tools

libtmux::mcp::ArgumentMap
libtmux::mcp::Arguments
libtmux::mcp::ArgumentType
libtmux::mcp::CallContext
libtmux::mcp::Effect
libtmux::mcp::FlatArguments
libtmux::mcp::Handler
libtmux::mcp::InputControl
libtmux::mcp::InputSink
libtmux::mcp::kConservativeAnnotations
libtmux::mcp::NestedAuthority
libtmux::mcp::OutputClass
libtmux::mcp::OutputShape
libtmux::mcp::Parameter
libtmux::mcp::ProcessReach
libtmux::mcp::ReadToolCall
libtmux::mcp::Sink
libtmux::mcp::StructuredValue
libtmux::mcp::ToolAnnotations
libtmux::mcp::ToolAuthority
libtmux::mcp::ToolDefinition
libtmux::mcp::ToolOutput
libtmux::mcp::ToolRegistry
libtmux::mcp::ToolResult
libtmux::mcp::ToolSchema

Configuration and environment

libtmux::mcp::configured_tools
libtmux::mcp::default_tools
libtmux::json_wire::from_json
libtmux::json_wire::is_known_field
libtmux::json_wire::kind_from
libtmux::json_wire::kSchemaVersion
libtmux::json_wire::name_of
libtmux::mcp::parse_tool_selection
libtmux::json_wire::to_json
libtmux::mcp::ToolSelection
libtmux::mcp::Toolset

Errors

libtmux::mcp::ToolError
Esc

Type to search.

Reference previewOpen reference