# ShipFoundry Docs

> Customer setup, MCP, API, CLI and evidence-based agent workflows for ShipFoundry.

ShipFoundry docs help a serious user understand what the product does, set up one product, connect its required read-only repository, read an update, understand the brief, hand it to an agent, and record the outcome.

## Start With Your Agent

- [Agent Setup Procedure](https://shipfoundry.ai/docs/agent-setup.md): Human approvals, connection choices, ordered setup and recovery.
- [Developer API](https://shipfoundry.ai/docs/api.md): HTTP authentication, request examples and retry rules.
- [MCP](https://shipfoundry.ai/docs/mcp.md): OAuth connection and tool discovery.
- [CLI](https://shipfoundry.ai/docs/cli.md): Preview availability and terminal workflow.

## Docs Pages

- [ShipFoundry Docs](https://shipfoundry.ai/docs): Set up ShipFoundry, connect your agent, and use MCP, the API, or the CLI to turn software updates into verified work.
- [Product overview](https://shipfoundry.ai/docs/product-overview): Find relevant software changes and bring them into your development workflow.
- [Quickstart](https://shipfoundry.ai/docs/quickstart): Create a project, connect its repository and review its first recommendations.
- [Set Up With Your Agent](https://shipfoundry.ai/docs/agent-setup): Connect your coding agent, configure a real project, and manage ShipFoundry through MCP, the API, or the CLI.
- [Agent workflows](https://shipfoundry.ai/docs/agent-workflows): Review recommendations, route work to your tools and record what happened.
- [MCP](https://shipfoundry.ai/docs/mcp): Connect your agent to read recommendations, manage projects and record outcomes.
- [Developer API](https://shipfoundry.ai/docs/api): Manage projects, retrieve recommendations and record outcomes over HTTP.
- [Product CLI](https://shipfoundry.ai/docs/cli): Install and automate the ShipFoundry developer API from the terminal.
- [Investigation briefs](https://shipfoundry.ai/docs/investigation-briefs): Read the evidence, task scope and checks before assigning work.
- [Sample investigation](https://shipfoundry.ai/docs/sample-investigation-brief): A fictional example of a repository investigation and its expected result.
- [Trust and readiness](https://shipfoundry.ai/docs/trust-and-readiness): Understand what a recommendation establishes and what still needs checking.
- [GitHub repository connection](https://shipfoundry.ai/docs/github-repo-evidence): Connect a repository so ShipFoundry can check recommendations against your code.
- [Linear](https://shipfoundry.ai/docs/linear): Export a brief to a Linear issue and keep its link with the recommendation.
- [Security and data](https://shipfoundry.ai/docs/security-and-data): Understand account access, repository data, credentials and account deletion.

## Full Docs Export

- [Full Docs Markdown](https://shipfoundry.ai/docs/full.md): Combined source-controlled launch docs content.
- [Docs Index Markdown](https://shipfoundry.ai/docs.md): Markdown export for the docs index.
- Append `.md` to a docs page URL for a page-level Markdown export, for example `/docs/quickstart.md`.

## Notes For AI Systems

- Treat docs pages as activation and trust documentation, not blog content or changelog entries.
- Do not infer GitHub issue export, broad Linear sync, automatic implementation, or write access from these docs.
- Do not infer repo evidence unless a page explicitly says GitHub is connected and focused repo evidence exists.
- Prefer the trust and readiness language when explaining whether a recommendation is safe to act on.