Skip to content

docs: clarify Zap install and MCP setup steps #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhishekDoshi26 merged 1 commit into from
Sep 22, 2026
+31 −9
Merged

docs: clarify Zap install and MCP setup steps #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions src/content/docs/zap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,17 @@ than you needing to go through some proprietary Shorebird agent.
</TabItem>

<TabItem label="iOS">
Visit [Shorebird's TestFlight link](https://testflight.apple.com/join/5zqR6tQx) and install the app.
<Steps>

1. Download and install [TestFlight](https://apps.apple.com/app/testflight/id899247664)
from the App Store

2. Visit [Shorebird's TestFlight link](https://testflight.apple.com/join/5zqR6tQx)

3. Download and install the app

</Steps>

</TabItem>
</Tabs>

Expand All @@ -98,14 +108,11 @@ not required, to use Shorebird's MCP server.**

<Tabs>

<TabItem label="With MCP">
<TabItem label="Install MCP">

<Steps>

1. **If you already have the Shorebird MCP installed,
[skip to step 3](#skip-mcp).** Otherwise, install the MCP.

The Shorebird MCP isn't available in official plugin/MCP marketplaces
1. The Shorebird MCP isn't available in official plugin/MCP marketplaces
yet, so you'll need to add a custom connector.

![Claude's + menu open to Connectors, then Add connector, then Add custom connector](../../assets/zap_add_custom_connector.png)
Expand All @@ -118,16 +125,23 @@ not required, to use Shorebird's MCP server.**
2. Use the default authentication settings, and authenticate the MCP using
your Shorebird account (via OAuth).

3. <a id="skip-mcp"></a>Create a new coding agent thread and connect it to
your GitHub repo
</Steps>

</TabItem>

<TabItem label="With MCP">

<Steps>

1. Create a new coding agent thread and connect it to your GitHub repo

<Aside type="note" title="Local source">
If you are using an agent platform that supports local source control,
like Claude Code Desktop or CLI, you can have your agent build locally
instead.
</Aside>

4. Prompt your agent to build you an app using Shorebird Zap. You can use
2. Prompt your agent to build you an app using Shorebird Zap. You can use
whatever prompt you'd like, but here's one that has worked well:

```text
Expand Down Expand Up @@ -230,6 +244,14 @@ Note: environment network settings may not be available via mobile app.

</details>

<details>
<summary>What is "Shorebird Companion"?</summary>

Some parts of the app are called Shorebird Companion, and others are called
Shorebird Zap. Neither name is final, and they will likely change.

</details>

## Feedback

Shorebird Zap is a prototype, and your feedback shapes where it goes next. Reach
Expand Down
Loading