Skip to content
Merged
Changes from all commits
Commits
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
155 changes: 8 additions & 147 deletions documentation/docs/mcp/neighborhood-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,153 +18,14 @@ This tutorial covers how to add the Neighborhood extension to goose, enabling yo
<TabItem value="ui" label="goose Desktop" default>
[Launch the installer](goose://extension?type=streamable_http&url=https%3A%2F%2Fconnect.squareup.com%2Fv2%2Fmcp%2Fneighborhood&id=neighborhood&name=Neighborhood&description=Discover%20nearby%20restaurants%2C%20browse%20menus%2C%20and%20place%20takeout%20orders%20through%20natural%20conversation.)
</TabItem>
<TabItem value="cli" label="goose CLI">

1. Run the `configure` command:

```sh
goose configure
```

2. Choose to add a `Remote Extension`

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◆ What type of extension would you like to add?
│ ○ Built-in Extension
│ ○ Command-line Extension (Run a local command or script)
// highlight-start
│ ● Remote Extension
// highlight-end
```

3. Give your extension a name

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
// highlight-start
◆ What would you like to call this extension?
│ Neighborhood
// highlight-end
```

4. Enter the remote endpoint URL

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ Neighborhood
// highlight-start
◆ What is the SSE endpoint URI?
│ https://connect.squareup.com/v2/mcp/neighborhood
// highlight-end
```

5. Enter the number of seconds goose should wait for actions to complete before timing out. Default is 300s

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ Neighborhood
◇ What is the SSE endpoint URI?
│ https://connect.squareup.com/v2/mcp/neighborhood
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```

6. Add a description if you want, otherwise select No to leave it blank.

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ Neighborhood
◇ What is the SSE endpoint URI?
│ https://connect.squareup.com/v2/mcp/neighborhood
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ ○ Yes / ● No
// highlight-end
```

7. No environment variables are needed, so select No.

```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ Neighborhood
◇ What is the SSE endpoint URI?
│ https://connect.squareup.com/v2/mcp/neighborhood
◇ Please set the timeout for this tool (in secs):
│ 300
◇ Would you like to add a description?
│ No
// highlight-start
◆ Would you like to add environment variables?
│ ○ Yes / ● No
// highlight-end
└ Added Neighborhood extension
```

</TabItem>
<TabItem value="cli" label="goose CLI">
Use `goose configure` to add a `Remote Extension (Streaming HTTP)` extension type with:

**Endpoint URL**
```
https://connect.squareup.com/v2/mcp/neighborhood
```
</TabItem>
</Tabs>
:::

Expand Down
Loading