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

# MCP Server

> Connect AI assistants to Autosana for docs and test management

Connect your AI coding assistant to Autosana for seamless documentation access and test flow management directly from your IDE.

## Configuration

Replace `<YOUR_API_KEY>` with your key from the welcome quickstart or [**Settings → Integrations → API Key**](https://autosana.ai/settings?tab=integrations).

<Tabs>
  <Tab title="Claude Code">
    Run this command in your terminal:

    ```bash theme={null}
    claude mcp add --transport http autosana https://mcp.autosana.ai/mcp --header "x-api-key: <YOUR_API_KEY>"
    ```
  </Tab>

  <Tab title="Claude Desktop">
    **Add this to**: `~/claude_desktop_config.json`

    ```json theme={null}
    {
      "mcpServers": {
        "autosana": {
          "url": "https://mcp.autosana.ai/mcp",
          "headers": {
            "x-api-key": "<YOUR_API_KEY>"
          }
        }
      }
    }
    ```
  </Tab>

  <Tab title="Cursor">
    **Add this to**: `~/.cursor/mcp.json`

    ```json theme={null}
    {
      "mcpServers": {
        "autosana": {
          "url": "https://mcp.autosana.ai/mcp",
          "headers": {
            "x-api-key": "<YOUR_API_KEY>"
          }
        }
      }
    }
    ```
  </Tab>

  <Tab title="Gemini CLI">
    Run this command in your terminal:

    ```bash theme={null}
    gemini mcp add --transport http autosana https://mcp.autosana.ai/mcp --header "x-api-key: <YOUR_API_KEY>"
    ```

    Or add this to your `~/.gemini/settings.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "autosana": {
          "httpUrl": "https://mcp.autosana.ai/mcp",
          "headers": {
            "x-api-key": "<YOUR_API_KEY>"
          }
        }
      }
    }
    ```
  </Tab>

  <Tab title="Codex">
    **Add this to**: `~/.codex/config.toml`

    ```toml theme={null}
    [mcp_servers.autosana]
    url = "https://mcp.autosana.ai/mcp"
    http_headers = { "x-api-key" = "<YOUR_API_KEY>" }
    ```
  </Tab>

  <Tab title="OpenClaw">
    **Add this to**: `~/.openclaw/openclaw.json`

    ```json theme={null}
    {
      "mcpServers": {
        "autosana": {
          "url": "https://mcp.autosana.ai/mcp",
          "headers": {
            "x-api-key": "<YOUR_API_KEY>"
          }
        }
      }
    }
    ```

    Or via mcporter, **add this to**: `~/.mcporter/mcporter.json`

    ```json theme={null}
    {
      "mcpServers": {
        "autosana": {
          "url": "https://mcp.autosana.ai/mcp",
          "headers": {
            "x-api-key": "<YOUR_API_KEY>"
          }
        }
      }
    }
    ```
  </Tab>
</Tabs>

After adding the configuration, restart your agent for the changes to take effect.

***

## Verify the Connection

Once configured, test the server:

```
List all my Autosana flows
```

```
How do suites work in Autosana?
```

If the connection is successful, you'll receive responses from both questions.

***

## Available Tools

The Autosana MCP server provides comprehensive test management, debugging, and documentation access.

### Flow Management

| Tool               | Description                                                        |
| ------------------ | ------------------------------------------------------------------ |
| `flows_list`       | List all flows in your organization, optionally filtered by suite  |
| `flows_read`       | Get details of a specific flow by ID                               |
| `flows_create`     | Create a new test flow with name, instructions, and optional suite |
| `flows_update`     | Update an existing flow's name or instructions                     |
| `flows_delete`     | Delete one or more flows (supports batch deletion)                 |
| `flows_run`        | Execute one or more flows on an app                                |
| `add_hook_to_flow` | Add a setup or teardown hook to a flow                             |

### Suite Management

| Tool            | Description                                                 |
| --------------- | ----------------------------------------------------------- |
| `suites_list`   | List all test suites in your organization                   |
| `suites_read`   | Get details of a specific suite by ID                       |
| `suites_create` | Create a new suite with flows and optional authentication   |
| `suites_update` | Update a suite's name, description, or authentication setup |
| `suites_delete` | Delete one or more suites (supports batch deletion)         |
| `suites_run`    | Execute all flows in a suite on an app                      |

### Hook Management

| Tool           | Description                                                      |
| -------------- | ---------------------------------------------------------------- |
| `hooks_list`   | List all hooks in your organization, optionally filtered by flow |
| `hooks_read`   | Get details of a specific hook by ID                             |
| `hooks_create` | Create a new hook with a script (cURL, Python, JS, Shell)        |
| `hooks_update` | Update an existing hook's name, script, type, or description     |
| `hooks_delete` | Delete one or more hooks (supports batch deletion)               |
| `hooks_run`    | Execute a hook and wait for results                              |

### Apps & Environments

| Tool                | Description                                           |
| ------------------- | ----------------------------------------------------- |
| `apps_list`         | List all active apps, optionally filtered by platform |
| `apps_read`         | Get details of a specific app by ID or name           |
| `environments_list` | List all environments for your organization           |

### Results & Debugging

| Tool              | Description                                                      |
| ----------------- | ---------------------------------------------------------------- |
| `list_suite_runs` | List recent suite run results with optional date filters         |
| `list_flow_runs`  | List recent flow run results with optional date filters          |
| `list_hook_runs`  | List recent hook run results with optional date filters          |
| `read_suite_run`  | Read detailed suite run info showing which flows passed/failed   |
| `read_flow_run`   | Read detailed flow run info including actions, review, and hooks |
| `read_hook_run`   | Read detailed hook run info including status and output          |

### Documentation

| Tool                   | Description                                   |
| ---------------------- | --------------------------------------------- |
| `search_autosana_docs` | Search Autosana documentation for information |

***

## Example Usage

#### Generate E2E tests from your codebase

```
Crawl my repo, come up with an E2E testing strategy, and create flows in Autosana
```

#### Increase test coverage from a PR

```
Look at this PR and get us to 80% E2E coverage by writing flows in Autosana
```

#### Debug failing tests

```
My login suite is failing. Help me figure out what's wrong and fix it.
```

#### Create hooks for backend setup

```
Create a setup hook that resets the test database before each flow runs
```

#### Check test run history

```
Show me the last 10 runs of my checkout flow and their success rates
```

#### Identify coverage gaps

```
Look at my Autosana coverage and see where we are missing tests
```

***

## Resources

* [MCP Protocol Specification](https://modelcontextprotocol.io)
* [Claude Code](https://docs.anthropic.com/en/docs/claude-code/mcp)
* [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
* [Cursor](https://docs.cursor.com/context/model-context-protocol)
* [Gemini CLI](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html)
* [Codex](https://developers.openai.com/codex/mcp/)
* [OpenClaw](https://docs.openclaw.ai/gateway/configuration)
* [Report an Issue](https://github.com/autosana/autosana/issues)