Skip to content
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.

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

docs: links for tutorials #1363

Merged
merged 1 commit into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
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
67 changes: 32 additions & 35 deletions documentation/docs/getting-started/using-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ Extensions are add-ons that provide a way to extend the functionality of Goose b
Extensions are based on the [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol), so you can connect
Goose to a wide ecosystem of capabilities.

:::tip Tutorials
Check out the [step-by-step tutorials](/docs/category/tutorials) for adding and using several Goose Extensions
:::


## Built-in Extensions
Out of the box, Goose is installed with a few extensions but with only the `Developer` extension enabled by default.

Expand Down Expand Up @@ -78,7 +83,7 @@ Here are the built-in extensions:
</Tabs>


:::tip
:::info
All of Goose's built-in extensions are MCP servers in their own right. If you'd like
to use the MCP servers included with Goose with any other agent, you are free to do so.
:::
Expand All @@ -95,16 +100,12 @@ You can also add any other [MCP Server](#mcp-servers) as a Goose extension, even

Extensions can be installed directly via the [extensions directory][extensions-directory], CLI, or UI.

:::tip
For advanced users, you can also edit the `~/.config/goose/config.yaml` file directly to add an extension.
:::

### MCP Servers

You can install any MCP server as a Goose extension.

:::tip MCP Server Directory
See available servers in the **[MCP Server Directory](https://github.com/modelcontextprotocol/servers?tab=readme-ov-file#model-context-protocol-servers)**.
See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/servers)**.
:::

<Tabs groupId="interface">
Expand All @@ -125,28 +126,28 @@ See available servers in the **[MCP Server Directory](https://github.com/modelco

4. Follow the prompts based on the type of extension you selected.

#### Example of adding the [Fetch MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch):
#### Example of adding the [Knowledge Graph Memory MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/memory):

```
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
fetch
◇ What command should be run?
uvx mcp-server-fetch
Would you like to add environment variables?
│ No
└ Added fetch extension
```
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
Knowledge Graph Memory
◇ What command should be run?
npx -y @modelcontextprotocol/server-memory
Would you like to add environment variables?
│ No
└ Added Knowledge Graph Memory extension
```

</TabItem>
<TabItem value="ui" label="Goose Desktop">
Expand All @@ -157,19 +158,15 @@ See available servers in the **[MCP Server Directory](https://github.com/modelco
4. On the `Add Extension Manually` modal, enter the necessary details and click `Add` button
5. Click `Add Extension` button

#### Example of adding the [Fetch MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch):
#### Example of adding the [Knowledge Graph Memory MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/memory):
* **Type**: `Standard IO`
* **ID**: `fetch` (_set this to whatever you want_)
* **Name**: `fetch` (_set this to whatever you want_)
* **Description**: `Fetch MCP Server` (_set this to whatever you want_)
* **Command**: `uvx mcp-server-fetch`
* **ID**: `kgm-mcp` (_set this to whatever you want_)
* **Name**: `Knowledge Graph Memory` (_set this to whatever you want_)
* **Description**: `maps and stores complex relationships between concepts` (_set this to whatever you want_)
* **Command**: `npx -y @modelcontextprotocol/server-memory`
</TabItem>
</Tabs>

:::tip Tutorials
Check out our [tutorials](/docs/category/tutorials) with step-by-step instructions on adding MCP Servers.
:::

### Config Entry
For advanced users, you can also directly edit the config file (`~/.config/goose/config.yaml`) to add, remove, or update an extension:

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/tutorials/jetbrains-mcp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: JetBrains Extension
description: Add JetBrains MCP Server as a Goose Extension
description: Use JetBrains MCP Server as a Goose Extension
---

import Tabs from '@theme/Tabs';
Expand Down