Quickstart

This guide uses the dashboard. For setup through MCP, the API or CLI, start with Set up with your agent.

Create and describe your project

1. Create an account and choose a plan.
2. Create a project for the product you maintain.
3. Add its summary, goals, constraints and important repository areas.

Use facts that will help distinguish useful work from distractions:

Your agent can inspect the repository and prepare this context. Confirm business facts it cannot infer from code.

Connect GitHub and choose a watchlist

Connect GitHub, approve read-only access, and select one repository for the project. Review the suggested watchlist and select the dependencies and services you want to follow. Include tools outside the codebase when they affect the product.

Finish the setup checks and confirm activation to start the first review. Check processing status while it runs. A successful activation request does not mean recommendations are ready yet.

Review the results

Open a recommendation and read its source evidence, repository findings and readiness state. Open the stored brief if one exists. Generating a new brief is an explicit action and can consume your plan's allowance.

You can inspect an item yourself, give its packet to an agent, or export a brief to Linear. After the work, record what happened and include supporting files, checks or a pull-request link.

Agent workflows shows how to repeat this review through your own scheduled agent runs or other automation.

If setup or results stall

• Check the project's setup and processing status for the remaining step.
• Confirm GitHub access and the selected repository.
• Check that the watchlist includes items covered by ShipFoundry's sources.
• If recommendations are too broad, update the product context and watchlist, and record incorrect matches.

An empty update list does not prove that processing failed or that nothing needs attention. Check the reported state first.

Was This Page Useful?

Send Feedback on Quickstart