MCPAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

Edit this page on GitHub

LibTmuxMCP API reference

LibTmuxMCP 0.1.0-alpha.1 · Source

Use LibTmuxMCP to configure the application and embed its stdio server. The application borrows an explicitly selected tmux endpoint and owns the sessions it creates.

Read the package guide for installation and complete examples.

API declarations

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

Exports

LibTmuxMCP.Application
Configure an MCP application without I/O. server is an explicit borrowed endpoint. Omitted pane targets use only caller; there is no ambient/current pane fallback. allowed_panes=nothing permits any explicitly addressed pane; otherwise copy the supplied generation-bound references as the allowlist. Tool names and pane policy also apply to each item in run_operations.
Base.close
Base.isopen
Base.show
Base.showerror
LibTmuxMCP.install_cli
LibTmuxMCP
LibTmuxMCP.main
ModelContextProtocol.close
ModelContextProtocol.is_connected
ModelContextProtocol.read_message
ModelContextProtocol.write_message
LibTmuxMCP.serve
LibTmuxMCP.tools
Esc

Type to search.

Reference preview Open reference