Documentation
¶
Overview ¶
Command mctop is a terminal client for MCP servers: explore a server in a TUI, script it headless, or assert its contract in CI. See DESIGN.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
demoserver
command
Command demoserver is a tiny MCP server over streamable HTTP, used to exercise mctop's http transport and as a public endpoint to point mctop at:
|
Command demoserver is a tiny MCP server over streamable HTTP, used to exercise mctop's http transport and as a public endpoint to point mctop at: |
|
internal
|
|
|
cli
Package cli implements mctop's headless subcommands.
|
Package cli implements mctop's headless subcommands. |
|
config
Package config persists mctop's small set of user preferences under the OS config dir, next to the cached OAuth credentials.
|
Package config persists mctop's small set of user preferences under the OS config dir, next to the cached OAuth credentials. |
|
mcp
Package mcp wraps the official MCP Go SDK into the small surface mctop needs: connect to a server, list its tools/resources/prompts, and call a tool.
|
Package mcp wraps the official MCP Go SDK into the small surface mctop needs: connect to a server, list its tools/resources/prompts, and call a tool. |
|
oauth
Package oauth gives mctop a login flow for OAuth-protected MCP servers: discover the server's authorization server, register a client, run the authorization-code flow with PKCE in the browser, and cache the resulting token so later commands authenticate without logging in again.
|
Package oauth gives mctop a login flow for OAuth-protected MCP servers: discover the server's authorization server, register a client, run the authorization-code flow with PKCE in the browser, and cache the resulting token so later commands authenticate without logging in again. |
|
spec
Package spec defines mctop's CI contract format and the engine that runs it against a connected server.
|
Package spec defines mctop's CI contract format and the engine that runs it against a connected server. |
|
tui
Package tui is mctop's interactive terminal client: connect to a server and move through it step by step, browse what it exposes, fill a tool's arguments, run it, and read the result, without leaving the keyboard.
|
Package tui is mctop's interactive terminal client: connect to a server and move through it step by step, browse what it exposes, fill a tool's arguments, run it, and read the result, without leaving the keyboard. |
|
ui
Package ui holds mctop's terminal styling: ANSI colors that switch off when output is not a terminal, plus the wordmark.
|
Package ui holds mctop's terminal styling: ANSI colors that switch off when output is not a terminal, plus the wordmark. |
|
upgrade
Package upgrade replaces the running mctop binary with the latest GitHub release: it finds the matching asset, verifies its checksum, and swaps the executable in place.
|
Package upgrade replaces the running mctop binary with the latest GitHub release: it finds the matching asset, verifies its checksum, and swaps the executable in place. |
Click to show internal directories.
Click to hide internal directories.
