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.0-alpha.14 · Source

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

LibTmux.Mcp is distributed as a .NET tool package. Installing its executable does not provide a NuGet library reference for embedding.

Source APILink to section

McpServerComposition.Add registers the server in a service collection and returns the MCP builder for transport composition. It accepts the connection options, caller pane ID, and a ServerPolicy containing wait and output limits. The public overload selects tools without teardown. Tool handlers are internal implementation details.

Composition source.

Protocol APILink to section

The tool reference uses names such as capture_pane and run_shell_command. Results provide structured content and bounded text. Read tmux://capabilities for the startup-frozen selection. The current surface has no workflow prompts or dynamic resource templates.

For the separately published configuration library, see Workspace builder API.

API declarations

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

Exports

LibTmux.Mcp.ActionResult
What a tool that changed tmux did.
LibTmux.Mcp.BoundedText
Terminal text cut to fit a budget, with what was cut reported.
LibTmux.Mcp.CaptureResult
What a pane was showing.
LibTmux.Mcp.ChannelWaitResult
What happened while waiting on a tmux wait-for channel.
LibTmux.Mcp.EnvironmentEntry
One variable in tmux's environment.
LibTmux.Mcp.HookEntry
One command tmux will run on an event.
LibTmux.Mcp.KeyStep
One keystroke in a batch.
LibTmux.Mcp.LibTmuxMcp
What this server says it is.
LibTmux.Mcp.MatchedLine
One line that matched a search.
LibTmux.Mcp.McpServerComposition
Assembles the server: what it offers, and what it refuses to.
LibTmux.Mcp.OptionEntry
One tmux option as read at one scope.
LibTmux.Mcp.PaneActivityHub
Tells a waiter the moment a pane prints something.
LibTmux.Mcp.PaneInfo
What a pane is and what is running in it.
LibTmux.Mcp.PaneInputResult
What pane input targeted after tmux synchronization was resolved.
LibTmux.Mcp.PaneMatch
One pane whose text matched a search.
LibTmux.Mcp.PaneSnapshot
A pane's content and its screen state, read together.
LibTmux.Mcp.RunResult
What a command did.
LibTmux.Mcp.SearchResult
What a search across panes found.
LibTmux.Mcp.ServerInstructions
What the client is told this server is for, before any tool is called.
LibTmux.Mcp.ServerPolicy
What this server will do, and how much of it at once.
LibTmux.Mcp.SessionInfo
What a session is.
LibTmux.Mcp.TailResult
What a pane has printed since it was last read.
LibTmux.Mcp.TmuxConnectionAccessor
Holds the tmux servers this process talks to, one per socket.
LibTmux.Mcp.TmuxServerInfo
What a tmux server is and how much it is holding.
LibTmux.Mcp.WaitOutcome
How a wait ended.
LibTmux.Mcp.WaitResult
What happened while waiting for a pane to print something.
LibTmux.Mcp.WindowInfo
What a window is and how it is laid out.
Esc

Type to search.