Skip to main content

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 exposes an OAuth-backed MCP server for workspace-scoped reads and approved writes. The MCP page in the dashboard shows the server endpoint and OAuth metadata URL.
Treat the MCP endpoint like an integration secret. It can expose workspace context after OAuth authorization, and write tools should only be used by trusted operators.

​
Connection flow

1

Open MCP Server in ShipOS

Go to Dashboard → MCP Server and copy the ShipOS server endpoint.
2

Register the endpoint

Add ShipOS as a custom MCP server in ChatGPT or another compatible client.
3

Authorize in the browser

Complete the OAuth prompt, then return to the MCP client.
4

Start read-only

Verify issue, project, message, and Company Knowledge reads before allowing mutation workflows.

​
Available tools

Read tools

Search issues, get an issue by ID, search projects, search Company Knowledge, search messages, and list ShipCode agents.

Write tools

Create issues, update issue fields, create notes or messages, and update Company Knowledge for admins.

​
Tool names

search_issues, get_issue, search_projects, search_company_knowledge, search_messages, and list_agents.
create_issue, update_issue, create_note_or_message, and update_company_knowledge.