-
Notifications
You must be signed in to change notification settings - Fork 5.9k
docs: Add VS Code tutorial #1798
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
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| --- | ||
| title: VS Code Extension | ||
| description: Use VS Code MCP Server as a Goose Extension for file operations and VS Code integration | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| This tutorial covers how to add the [VS Code MCP Server](https://github.com/block/vscode-mcp) as a Goose extension to enable VS Code integration, file operations, and development workflow management. | ||
|
|
||
| :::tip TLDR | ||
|
|
||
| **Command** | ||
| ```sh | ||
| npx vscode-mcp-server | ||
| ``` | ||
|
|
||
| **Required Setup** | ||
|
|
||
| Install the [VS Code MCP Extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-mcp-extension) from the marketplace | ||
| ::: | ||
|
|
||
| ## Configuration | ||
|
|
||
| :::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 Extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-mcp-extension) to your VS Code. No additional settings required in VS Code. | ||
|
angiejones marked this conversation as resolved.
Outdated
|
||
|
|
||
| <Tabs groupId="interface"> | ||
| <TabItem value="cli" label="Goose CLI" default> | ||
| 1. Run the `configure` command: | ||
| ```sh | ||
| goose configure | ||
| ``` | ||
|
|
||
| 2. Choose to add a `Command-line Extension` | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◆ What type of extension would you like to add? | ||
| │ ○ Built-in Extension | ||
| // highlight-start | ||
| │ ● Command-line Extension (Run a local command or script) | ||
| // highlight-end | ||
| │ ○ Remote Extension | ||
| └ | ||
| ``` | ||
|
|
||
| 3. Give your extension a name | ||
| ```sh | ||
| ┌ goose-configure | ||
| │ | ||
| ◇ What would you like to configure? | ||
| │ Add Extension | ||
| │ | ||
| ◇ What type of extension would you like to add? | ||
| │ Command-line Extension | ||
| │ | ||
| // highlight-start | ||
| ◆ What would you like to call this extension? | ||
| │ vscode-mcp | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 4. Enter the command | ||
| ```sh | ||
| ┌ 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? | ||
| │ vscode-mcp | ||
| │ | ||
| // highlight-start | ||
| ◆ What command should be run? | ||
| │ npx vscode-mcp-server | ||
| // highlight-end | ||
| └ | ||
| ``` | ||
|
|
||
| 5. Enter the timeout value (default 300s is recommended) | ||
| ```sh | ||
| ┌ 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? | ||
| │ vscode-mcp | ||
| │ | ||
| ◇ What command should be run? | ||
| │ npx vscode-mcp-server install | ||
| │ | ||
| // highlight-start | ||
| ◆ Please set the timeout for this tool (in secs): | ||
| │ 300 | ||
| // highlight-end | ||
| │ | ||
| └ | ||
| ``` | ||
|
|
||
| 6. No additional environment variables are required for basic setup | ||
|
|
||
| </TabItem> | ||
| <TabItem value="ui" label="Goose Desktop"> | ||
| 1. [Launch the installer](goose://extension?cmd=npx&arg=-y&arg=vscode-mcp-server&id=vscode-mcp&name=VS%20Code%20MCP&description=VS%20Code%20integration%20and%20file%20operations) | ||
| 2. Press `Yes` to confirm the installation | ||
| 3. Click `Save Configuration` | ||
| 4. Click `Exit` from the upper left corner | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## VS Code Extension | ||
|
angiejones marked this conversation as resolved.
Outdated
|
||
|
|
||
| No additional setup is required to use the VS Code MCP extension in VS Code. | ||
|
angiejones marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Example Usage | ||
|
|
||
| The VS Code MCP extension enables Goose to interact with your VS Code environment, managing files, projects, and development workflows. | ||
|
|
||
| The key strength of the VS Code MCP Server is its ability to: | ||
|
|
||
| - Show diffs before making changes | ||
| - Integrate file operations with VS Code's interface | ||
| - Manage project workspaces | ||
| - Provide immediate visual feedback in the editor | ||
|
|
||
|
|
||
| :::note | ||
| Every time you start a Goose session with the VS Code MCP server enabled, it checks to see if a matching project is open in VS Code. If not, it will prompt you to open the project before proceeding. | ||
| ::: | ||
|
|
||
| ### Goose Prompt | ||
|
|
||
| ``` | ||
| Update the contributing guide with instructions on how to start docusaurus dev server | ||
| ``` | ||
|
|
||
| ## Result | ||
|
|
||
|  | ||
|
angiejones marked this conversation as resolved.
Outdated
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.