Files
goose/documentation/docs/tutorials/_template_.md
2025-02-05 08:10:22 -06:00

3.7 KiB

title: {name} Extension description: Add {name} MCP Server as a Goose Extension

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

This tutorial covers how to add the {name} MCP Server as a Goose extension to enable file operations, repository management, search functionality, and more.

:::tip TLDR

Command

{command}

Environment Variable

{env_var}: <YOUR_TOKEN>

:::

Configuration

1. Run the `configure` command: ```sh goose configure ```
  1. Choose to add a Command-line Extension
  ┌   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 
  └ 
  1. Give your extension a name
  ┌   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?
  │  {name}
  // highlight-end
  └ 
  1. Enter the command
  ┌   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?
  │  {name}
  │
  // highlight-start
  ◆  What command should be run?
  │  {command}
  // highlight-end
  └ 
  1. Obtain a GitHub Personal Access Token and paste it in. :::info When creating your access token, you can specify the repositories and granular permissions you'd like Goose to have access to. :::
 ┌   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?
 │  {name}}
 │
 ◇  What command should be run?
 │  {command}}
 // highlight-start
 ◆  Would you like to add environment variables?
 │  Yes 
 │
 ◇  Environment variable name:
 │  {env_var}
 │
 ◇  Environment variable value:
 │  ▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪
 │
 ◇  Add another environment variable?
 │  No 
 // highlight-end
 └  Added github extension
1. Click `...` in the upper right corner 2. Click `Settings` 3. Under `Extensions`, click the `Add` link 4. On the `Add Extension Manually` modal, enter the following: * **Type**: `Standard IO` * **ID**: `{name}-mcp` (_set this to whatever you want_) * **Name**: `{name}` (_set this to whatever you want_) * **Description**: `{name} MCP Server` (_set this to whatever you want_) * **Command**: `{command}` * **Environment Variables** * **Name**: `{env_var}` * **Value**: (_Obtain a [{env_var}](/) and paste it in._) * Click `Add` button 5. Click `Add Extension` button

Example Usage

{describe any environment setup, access controls, and what you want to accomplish.}

Goose Prompt

{exact prompt}.

Goose Output

{exact output}