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

# ShipOS MCP

> Connect ChatGPT or another MCP client to Shipyard workspace context.

ShipOS exposes an MCP server for workspace-scoped reads and approved writes. You can connect with either an API key (simplest, works in any client) or OAuth (used by ChatGPT). The MCP page in the dashboard shows the server endpoint.

<Warning>
  Treat the MCP endpoint like an integration secret. It can expose workspace context after authorization, and write tools should only be used by trusted operators.
</Warning>

## Connect with an API key

Use this for clients that don't support OAuth, including Warp and most terminal-based assistants.

<Steps>
  <Step title="Create a Console API key">
    In the [Shipyard Console](/console-api-keys), open **API Keys** and create a new key. Copy it immediately — the full value is only shown once.
  </Step>

  <Step title="Configure your MCP client">
    Point your client at `https://mcp.shipyard.lol/api/mcp` and send the key in the `Authorization` header.

    ```json theme={null}
    {
      "mcpServers": {
        "shipyard": {
          "url": "https://mcp.shipyard.lol/api/mcp",
          "headers": {
            "Authorization": "Bearer sh_your_api_key"
          }
        }
      }
    }
    ```
  </Step>

  <Step title="Revoke when rotating">
    Revoke unused or exposed keys from the Console **API Keys** page.
  </Step>
</Steps>

## Connect with OAuth

Use this for ChatGPT and other clients that natively support MCP OAuth.

<Steps>
  <Step title="Open MCP Server in ShipOS">
    Go to **Dashboard** → **MCP Server** and copy the ShipOS server endpoint.
  </Step>

  <Step title="Register the endpoint">
    Add ShipOS as a custom MCP server in ChatGPT or another compatible client.
  </Step>

  <Step title="Authorize in the browser">
    Complete the OAuth prompt, then return to the MCP client.
  </Step>

  <Step title="Start read-only">
    Verify issue, project, message, and Company Knowledge reads before allowing mutation workflows.
  </Step>
</Steps>

## Available tools

<Columns cols={2}>
  <Column>
    <Card title="Read tools" icon="eye">
      Search issues, get an issue by ID, search projects, search Company Knowledge, search messages, and list ShipCode agents.
    </Card>
  </Column>

  <Column>
    <Card title="Write tools" icon="pencil">
      Create issues, update issue fields, create notes or messages, and update Company Knowledge for admins.
    </Card>
  </Column>
</Columns>

## Tool names

<Accordion title="Read tools">
  `search_issues`, `get_issue`, `search_projects`, `search_company_knowledge`, `search_messages`, and `list_agents`.
</Accordion>

<Accordion title="Write tools">
  `create_issue`, `update_issue`, `create_note_or_message`, and `update_company_knowledge`.
</Accordion>