Skip to content

docs: update jetbrains tutorial #3971

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
dianed-square merged 1 commit into from
Aug 8, 2025
Merged

docs: update jetbrains tutorial #3971

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions documentation/docs/mcp/_template_.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This tutorial covers how to add the [{Extension Name} MCP Server](/) as a Goose
<GooseDesktopInstaller
extensionId="{extension_id}"
extensionName="{Extension Name}"
extensionDescription="{Extension description}"
description="{Extension description}"
command="npx"
args={["-y", "@package/name"]}
cliCommand="{command}"
Expand All @@ -53,15 +53,15 @@ This tutorial covers how to add the [{Extension Name} MCP Server](/) as a Goose
<!-- For built-in extensions -->
<GooseBuiltinInstaller
extensionName="{Extension Name}"
extensionDescription="{Extension description}"
description="{Extension description}"
extensionId="{extension_id}"
/>

<!-- For external MCP servers with environment variables -->
<GooseDesktopInstaller
extensionId="{extension_id}"
extensionName="{Extension Name}"
extensionDescription="{Extension description}"
description="{Extension description}"
command="npx"
args={["-y", "@package/name"]}
cliCommand="{command}"
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/mcp/context7-mcp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This tutorial covers how to add the [Context7 MCP Server](https://github.com/ups
<GooseDesktopInstaller
extensionId="context7"
extensionName="Context7"
extensionDescription="Context7 MCP server for up-to-date code and docs"
description="Context7 MCP server for up-to-date code and docs"
command="npx"
args={["-y", "@upstash/context7-mcp"]}
cliCommand="npx -y @upstash/context7-mcp"
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/mcp/gitmcp-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This tutorial covers how to add the [Git MCP Server](https://github.com/idosal/g
<GooseDesktopInstaller
extensionId="Git-mcp"
extensionName="Git mcp"
extensionDescription="Git MCP server for up-to-date docs and project insights"
description="Git MCP server for up-to-date docs and project insights"
command="npx"
args={["-y", "mcp-remote" , "https://gitmcp.io/docs"]}
cliCommand="npx -y mcp-remote https://gitmcp.io/docs"
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/mcp/goose-docs-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This tutorial covers how to add the [Goose Docs MCP Server](https://github.com/i
<GooseDesktopInstaller
extensionId="goose-docs"
extensionName="Goose Docs"
extensionDescription="GitMCP for Goose documentation"
description="GitMCP for Goose documentation"
command="npx"
args={["mcp-remote", "https://block.gitmcp.io/goose/"]}
cliCommand="npx mcp-remote https://block.gitmcp.io/goose/"
Expand Down
132 changes: 38 additions & 94 deletions documentation/docs/mcp/jetbrains-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,117 +6,61 @@ description: Use JetBrains MCP Server as a Goose Extension
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed';
import GooseBuiltinInstaller from '@site/src/components/GooseBuiltinInstaller';
import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller';
import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions';

<YouTubeShortEmbed videoUrl="https://www.youtube.com/embed/1fP5elf9qQM" />

The JetBrains extension is designed to work within your IDE. Goose can accomplish a lot of the developer-centric tasks with the Developer extension that is enabled on install, however, the JetBrains extension provides a more integrated and project-aware way to work with code.

This tutorial covers how to enable and use the JetBrains MCP Server as a built-in Goose extension to integrate with any JetBrains IDE.

## Configuration

1. Add the [MCP Server plugin](https://plugins.jetbrains.com/plugin/26071-mcp-server) to your IDE.

2. Enable built-in Goose extension:
This tutorial covers how to add the [JetBrains MCP Proxy Server](https://github.com/JetBrains/mcp-jetbrains) as a Goose extension to integrate with any JetBrains IDE.

:::tip TLDR
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
<GooseBuiltinInstaller
extensionName="Jetbrains"
description="Integrate Goose with any JetBrains IDE"
/>
[Launch the installer](goose://extension?cmd=npx&arg=-y&arg=%40jetbrains%2Fmcp-proxy&id=jetbrains&name=JetBrains&description=Integrate%20Goose%20with%20any%20JetBrains%20IDE)
</TabItem>
<TabItem value="cli" label="Goose CLI">

1. Run the `configure` command:
**Command**
```sh
goose configure
npx -y @jetbrains/mcp-proxy
```
</TabItem>
</Tabs>

2. Choose to add a `Built-in 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?
// highlight-start
│ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end
│ ○ Command-line Extension
│ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
└
```
**Required Setup**

3. Arrow down to the `JetBrains` extension and press Enter
```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
│
◆ Which built-in extension would you like to enable?
│ ○ Developer Tools
│ ○ Computer Controller
│ ○ Google Drive
│ ○ Memory
// highlight-start
│ ● JetBrains (Connect to jetbrains IDEs)
// highlight-end
└
```
Add the [MCP Server plugin](https://plugins.jetbrains.com/plugin/26071-mcp-server) to your IDE.
:::

4. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
## Configuration

```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
│
◇ Which built-in extension would you like to enable?
│ JetBrains
│
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
│
└ Enabled jetbrains extension
```
:::info
Note that you'll need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses `npx`.
:::

1. Add the [MCP Server plugin](https://plugins.jetbrains.com/plugin/26071-mcp-server) to your IDE.

2. Add the JetBrains extension to Goose:

<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
<GooseDesktopInstaller
extensionId="jetbrains"
extensionName="JetBrains"
description="Integrate Goose with any JetBrains IDE"
command="npx"
args={["-y", "@jetbrains/mcp-proxy"]}
timeout={300}
/>
</TabItem>
<TabItem value="cli" label="Goose CLI">
<CLIExtensionInstructions
name="jetbrains"
command="npx -y @jetbrains/mcp-proxy"
timeout={300}
/>

5. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the 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
│
◇ Which built-in extension would you like to enable?
│ JetBrains
│
◇ Please set the timeout for this tool (in secs):
│ 300
│
// highlight-start
◆ Would you like to add a description?
│ No
// highlight-end
│
└
```
</TabItem>
</Tabs>

Expand Down
22 changes: 11 additions & 11 deletions documentation/static/servers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,6 @@
"endorsed": true,
"environmentVariables": []
},
{
"id": "jetbrains",
"name": "JetBrains",
"description": "Built-in JetBrains IDE integration for development workflows",
"command": "",
"link": "https://github.com/block/goose/tree/main/crates/goose-mcp/src/jetbrains",
"installation_notes": "This is a built-in extension that comes with Goose and can be enabled on the Extensions page.",
"is_builtin": true,
"endorsed": true,
"environmentVariables": []
},
{
"id": "knowledge_graph_memory",
"name": "Knowledge Graph Memory",
Expand Down Expand Up @@ -397,6 +386,17 @@
}
]
},
{
"id": "jetbrains",
"name": "JetBrains",
"description": "Integrate Goose with any JetBrains IDE",
"command": "npx -y @jetbrains/mcp-proxy",
"link": "https://github.com/JetBrains/mcp-jetbrains",
"installation_notes": "Install using npx package manager. Requires the MCP Server plugin to be installed in your JetBrains IDE.",
"is_builtin": false,
"endorsed": true,
"environmentVariables": []
},
{
"id": "mbot-mcp",
"name": "MBot",
Expand Down