Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/superradcompany/tool-cli/llms.txt

Use this file to discover all available pages before exploring further.

Fetch and display the capabilities of a registry tool without installing it. Useful for evaluating a tool before committing to tool install.

Synopsis

tool preview <namespace/name[@version]> [flags]

Arguments

<tool>
string
required
Tool reference in namespace/name format. Append @version to pin a specific release (e.g., appcypher/bash@1.0.0). Omitting the version uses the latest published release.

Flags

-m, --method
string[]
Focus output on one or more specific methods. Repeat the flag to include multiple methods (e.g., -m exec -m read).
--input
boolean
Show only the input schema for the selected method(s). Requires -m.
--output
boolean
Show only the output schema for the selected method(s). Requires -m.
-d, --description
boolean
Show only the description for the tool or selected method(s).
--tools
boolean
Show only the list of tools (MCP tool capabilities) exposed by the server.
--prompts
boolean
Show only the list of prompts exposed by the server.
-a, --all
boolean
Show all capabilities: tools, prompts, and resources.
--json
boolean
Emit output as JSON. Useful for programmatic parsing or passing to other tools.
-L, --level
number
default:"3"
Maximum depth for expanding nested types in schema output. Increase this value to see deeply nested object shapes.

Examples

# Preview the latest version of a tool
tool preview appcypher/bash

# Preview a specific version
tool preview appcypher/bash@1.0.0

# Inspect a specific method's input and output schemas
tool preview ns/tool -m exec

# List tools only (no prompts or resources)
tool preview ns/tool --tools

# JSON output for parsing or piping
tool preview ns/tool --json

# Concise output (global flag)
tool preview ns/tool -c
tool preview does not require authentication and does not modify any local state. It is safe to run at any time.
To inspect a tool you have already installed (including local tools), use tool info instead. tool info also supports live server connections via config values.

Build docs developers (and LLMs) love