> ## Documentation Index
> Fetch the complete documentation index at: https://docs.golf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Complete command-line interface reference for testing MCP servers with detailed specifications for all commands.

## Quick Reference

| Command                            | Purpose                                             |
| ---------------------------------- | --------------------------------------------------- |
| `mcp-t quickstart`                 | Complete onboarding experience for first-time users |
| `mcp-t generate`                   | Automatically generate test suites using AI         |
| `mcp-t run <suite-id> <server-id>` | Execute test suite against MCP server               |
| `mcp-t create server`              | Create MCP server configuration                     |
| `mcp-t create suite`               | Create test suite with type selection               |
| `mcp-t list [type]`                | List available configurations                       |
| `mcp-t show <type> <id>`           | Show detailed configuration                         |
| `mcp-t report issue`               | Report bugs or issues                               |
| `mcp-t --version`                  | Show version information                            |
| `mcp-t --help`                     | Show help for any command                           |

***

# Commands by Category

## Setup & Onboarding

### `mcp-t quickstart`

Complete onboarding experience for first-time users with streamlined workflow.

### Syntax

```bash theme={null}
mcp-t quickstart
```

***

## Test Execution

Commands for running tests against MCP servers.

### `mcp-t run`

Execute test suites against MCP servers with comprehensive reporting.

### Syntax

```bash theme={null}
mcp-t run <suite-id> <server-id> [options]
```

### Arguments

* **`suite-id`** - ID of the test suite to execute (supports tab completion)
* **`server-id`** - ID of the MCP server to test against (supports tab completion)

### Options

* **`--verbose`, `-v`** - Show detailed test execution output
* **`--global`** - Save results to global directory instead of local ./test\_results/

### Examples

```bash theme={null}
# Basic test execution
mcp-t run basic-tests dev-server

# Verbose output with detailed conversation logs
mcp-t run user-workflows prod-server --verbose

# Save results to global directory
mcp-t run compliance-suite staging-server --global
```

***

## Configuration Management

### `mcp-t create`

Interactive configuration creation with templates and guided setup.

### Syntax

```bash theme={null}
mcp-t create <type> [options]
```

### Subcommands

* **`mcp-t create server`** - Create MCP server configuration
* **`mcp-t create suite`** - Create test suite with type selection

***

#### `mcp-t create server`

Create MCP server configuration with guided setup.

### Syntax

```bash theme={null}
mcp-t create server [options]
```

### Options

* **`--global`** - Save configuration globally (\~/.config/mcp-t/) instead of locally (./configs/)
* **`--id <server-id>`** - Specify server ID (if not provided, will prompt)

### Examples

```bash theme={null}
# Interactive server creation
mcp-t create server

# Create server with specific ID
mcp-t create server --id prod-server-1

# Save to global configuration directory
mcp-t create server --global --id shared-dev-server
```

***

#### `mcp-t create suite`

Create test suite with interactive type selection and templates.

### Syntax

```bash theme={null}
mcp-t create suite [options]
```

### Options

* **`--global`** - Save configuration globally instead of locally
* **`--id <suite-id>`** - Specify suite ID (if not provided, will prompt)

### Examples

```bash theme={null}
# Full interactive suite creation with type selection
mcp-t create suite

# Create suite with specific ID
mcp-t create suite --id my-integration-tests
```

***

### `mcp-t list`

View existing configurations and their details.

### Syntax

```bash theme={null}
mcp-t list [type] [options]
```

### Subcommands

* **`mcp-t list`** - Show all configurations (servers and suites)
* **`mcp-t list servers`** - Show only server configurations
* **`mcp-t list suites`** - Show only test suite configurations

### Examples

```bash theme={null}
# List all configurations
mcp-t list

# List only servers
mcp-t list servers

# List only test suites
mcp-t list suites
```

### `mcp-t show`

Display detailed configuration information for servers or test suites.

### Syntax

```bash theme={null}
mcp-t show <type> <id>
```

### Subcommands

* **`mcp-t show server <server-id>`** - Display server configuration details
* **`mcp-t show suite <suite-id>`** - Display test suite configuration details

### Examples

```bash theme={null}
# Show server details
mcp-t show server prod-server

# Show suite details
mcp-t show suite user-workflows
```

***

## Test Generation

### `mcp-t generate`

Starts a wizard to automatically generate comprehensive test suites for MCP servers using AI-powered research and test creation.
For detailed information, see the [Automatic Test Generation guide](/mcp-testing/getting-started/test-generation).

### Syntax

```bash theme={null}
mcp-t generate [options]
```

### Options

* **`--global`** - Save generated test suite globally (\~/.config/mcp-t/) instead of locally (./configs/)

***

## Reporting

### `mcp-t report issue`

Report bugs or issues with the MCP Testing Framework.

### Syntax

```bash theme={null}
mcp-t report issue [options]
```

### Options

* **`--category`** - Issue category selection
* **`--title`** - Brief issue title
* **`--description`** - Detailed issue description
* **`--no-diagnostics`** - Exclude system diagnostic information
* **`--no-history`** - Exclude recent command history
* **`--dry-run`** - Preview report without submitting

### Description

Opens an interactive bug report form to collect information about issues and submit them to the development team.

### Examples

```bash theme={null}
# Interactive bug report
mcp-t report issue

# Report with specific details
mcp-t report issue --category bug --title "CLI crashes on startup"

# Preview report without submitting
mcp-t report issue --dry-run
```

***

# Configuration Reference

## Storage Locations

### Configuration Files

**Local Configurations** (Project-specific):

```
./configs/
├── servers/          # MCP server configurations
│   ├── dev-server.json
│   └── prod-server.json
└── suites/           # Test suite configurations
    ├── basic-tests.json
    └── user-workflows.json
```

**Global Configurations** (System-wide):

```
~/.config/mcp-t/
├── servers/          # Shared server configurations
│   └── shared-prod.json
└── suites/           # Shared test suites
    ├── compliance-suite.json
    └── security-suite.json
```

### Test Results

**Local Results** (default):

```
./test_results/
└── runs/
    ├── 2025-01-15_14-30-45_basic-tests_dev-server/
    └── 2025-01-15_15-22-10_compliance_prod-server/
```

**Global Results** (with `--global` flag):

```
~/.local/share/mcp-t/
├── results/
│   └── runs/
│       ├── 2025-01-15_14-30-45_basic-tests_dev-server/
│       └── 2025-01-15_15-22-10_compliance_prod-server/
└── cache/
```

### Configuration Precedence

1. **Local configurations** (`./configs/`) - Highest priority
2. **Global configurations** (`~/.config/mcp-t/`) - Fallback
3. **Built-in templates** - Default templates for creation

***

# Shell Completion

Automatic tab completion for commands, server IDs, suite IDs, and options.

## Setup

```bash theme={null}
# Automatic during quickstart
mcp-t quickstart
```

## Supported Shells

* **Bash** - Full tab completion support
* **Zsh** - Full tab completion support

## Tab Completion Features

* **Commands**: `mcp-t [TAB]` shows all available commands
* **Server IDs**: `mcp-t run my-suite [TAB]` shows configured servers
* **Suite IDs**: `mcp-t run [TAB]` shows available test suites

***

For additional help and troubleshooting resources, see the [FAQ](/mcp-testing/troubleshooting/faq).
