Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Edit this page on GitHub

libtmux-mcp 0.0.1-alpha.12-SNAPSHOT · Source

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

TmuxMcpServer is the public Java entry point. The MCP catalog includes operations implemented by package-private classes; Java visibility does not determine whether a tool exists on the wire.

Java entry pointsLink to section

TmuxMcpServer.overStdio(server) serves through standard input and output. TmuxMcpServer.serving(server, transport) accepts a custom McpServerTransportProvider. Both return an SDK McpSyncServer.

The returned server owns its transport. Ownership transfers on entry, including startup failure. The embedding application owns the broader tmux server lifetime and closes the MCP server when serving ends.

Public source contract.

MCP tools and resourceLink to section

The tool reference covers registered operation names and input/output schemas. Results contain typed structuredContent and JSON text. Expected tmux failures become tool errors so the caller can inspect the failure and choose a recovery.

The tmux://capabilities resource is static for the process lifetime. It reports tool selection, connection provenance, and capability declarations. The server does not register prompts or dynamic hierarchy subscriptions.

Use the Workspace builder API for declarative configuration. It is a separate Java library and has no corresponding workspace-file MCP route.

API declarations

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

Exports

io.github.libtmux.mcp.Main.Main
Runs the tmux MCP server over stdin and stdout.
io.github.libtmux.mcp.TmuxMcpServer.TmuxMcpServer
Exposes a tmux server to a model over the Model Context Protocol.
Esc

Type to search.