# airbyte-ops-mcp

MCP and API interfaces that let the agents do the admin work.

## How to Contribute

- [CONTRIBUTING.md](./CONTRIBUTING.md) — contributor setup, local testing, and development workflows.
- [AGENTS.md](./AGENTS.md) — agent-specific operating guidance.

## Documentation

- [CLI Reference](https://airbytehq.github.io/airbyte-ops-mcp/airbyte_ops_mcp/cli.html) — `airbyte-ops` command-line interface
- [MCP Tools Reference](https://airbytehq.github.io/airbyte-ops-mcp/airbyte_ops_mcp/mcp.html) — Model Context Protocol server tools

## Ops Repo Subprojects

| Subproject | Root dir | Description | Release notes |
| --- | --- | --- | --- |
| `airbyte-internal-ops` | `.` | MCP server and `airbyte-ops` CLI for Airbyte admin operations. | [v0 releases](https://github.com/airbytehq/airbyte-ops-mcp/releases?q=tag:v0) |
| `airbyte-cloud-cli` | `airbyte-cloud-cli/` | Standalone CLI for Airbyte Cloud operations. | [v0 releases](https://github.com/airbytehq/airbyte-ops-mcp/releases?q=tag:airbyte-cloud-cli/v0) |
| Sentry infrastructure | `infra/sentry/` | Pulumi project for connector error monitoring configuration. | N/A |
| Agent message bus infrastructure | `infra/agent-message-bus/` | Pulumi and Cloud Run app for internal agent messaging. | N/A |

GitHub's Releases UI does not group releases by package automatically. Use a tag filter with the exact tag namespace and at least major-version precision, such as `tag:v0` or `tag:airbyte-cloud-cli/v0`, or use the links above.

## Installing Ops MCP in your Client

This config example will help you add the MCP server to your client:

```json
{
  "mcpServers": {
    "airbyte-ops-mcp": {
      "type": "stdio",
      "command": "uv",
      "args": [
        "run",
        "--project=/Users/aj.steers/repos/airbyte-ops-mcp/",
        "airbyte-ops-mcp"
      ],
      "env": {
        "AIRBYTE_MCP_ENV_FILE": "/Users/{user-id}/.mcp/airbyte_mcp.env"
      }
    },
    "airbyte-coral-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--python=3.11",
        "--from=airbyte@latest",
        "airbyte-mcp"
      ],
      "env": {
        "AIRBYTE_MCP_ENV_FILE": "/Users/{user-id}/.mcp/airbyte_mcp.env"
      }
    }
  }
}
```

Your `.env` file should include the following values:

```ini
# Creds for Airbyte Cloud OAuth
AIRBYTE_CLOUD_CLIENT_ID="..."
AIRBYTE_CLOUD_CLIENT_SECRET="..."

# Required for elevated admin operations
AIRBYTE_INTERNAL_ADMIN_FLAG=airbyte.io
AIRBYTE_INTERNAL_ADMIN_USER={my-id}@airbyte.io

# Workspace ID for Testing
AIRBYTE_CLOUD_TEST_WORKSPACE_ID="..."
```

## Onboarding

If this is your first time working with Airbyte's connector tooling, see [ONBOARDING.md](./ONBOARDING.md) for instructions on setting up required credentials like `GCP_GSM_CREDENTIALS`.

## Connector Registry

For an overview of the connector registry architecture, operations, and CLI commands, see [docs/connector-registry.md](./docs/connector-registry.md).

For release-block marker operations that prevent republishing known-bad connector code after a yank, see [docs/release-blocks.md](./docs/release-blocks.md).

For details on known, intentional differences between the new Registry 2.0 generation pipeline and the legacy pipeline, see [Connector Registry 2.0 Migration Changes](./CONTRIBUTING.md#connector-registry-20-migration-changes) in CONTRIBUTING.md.

## Getting Started

Once configured, use the `test_my_tools` prompt by typing "/test" into your agent and selecting the auto-complete option for the `test_my_tools` prompt.

This prompt will step through all the tools, demoing their capabilities.
