mirror of
https://github.com/aljazceru/goose.git
synced 2025-12-18 22:54:24 +01:00
goose docs MCP server (#3665)
This commit is contained in:
@@ -1,97 +0,0 @@
|
||||
---
|
||||
title: {name} Extension
|
||||
|
||||
escription: Add {name} MCP Server as a Goose Extension
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed';
|
||||
import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions';
|
||||
import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller';
|
||||
import GooseBuiltinInstaller from '@site/src/components/GooseBuiltinInstaller';
|
||||
|
||||
|
||||
<YouTubeShortEmbed videoUrl="https://www.youtube.com/embed/VIDEO_ID" />
|
||||
|
||||
|
||||
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
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="Goose Desktop" default>
|
||||
[Launch the installer]({goose_url})
|
||||
</TabItem>
|
||||
<TabItem value="cli" label="Goose CLI">
|
||||
**Command**
|
||||
```sh
|
||||
{command}
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
**Environment Variable**
|
||||
```
|
||||
{env_var}: <ENV_VALUE>
|
||||
```
|
||||
:::
|
||||
|
||||
## Configuration
|
||||
|
||||
<!-- For external MCP servers (npx, uvx, git, etc.) -->
|
||||
<GooseDesktopInstaller
|
||||
extensionId="{extension_id}"
|
||||
extensionName="{Extension Name}"
|
||||
extensionDescription="{Extension description}"
|
||||
command="npx"
|
||||
args={["-y", "@package/name"]}
|
||||
cliCommand="npx -y @package/name"
|
||||
timeout={300}
|
||||
note="Note that you'll need Node.js installed on your system to run this command, as it uses npx."
|
||||
/>
|
||||
|
||||
<!-- For built-in extensions -->
|
||||
<GooseBuiltinInstaller
|
||||
extensionName="{Extension Name}"
|
||||
extensionDescription="{Extension description}"
|
||||
extensionId="{extension_id}"
|
||||
/>
|
||||
|
||||
<!-- For external MCP servers with environment variables -->
|
||||
<GooseDesktopInstaller
|
||||
extensionId="{extension_id}"
|
||||
extensionName="{Extension Name}"
|
||||
extensionDescription="{Extension description}"
|
||||
command="npx"
|
||||
args={["-y", "@package/name"]}
|
||||
cliCommand="npx -y @package/name"
|
||||
timeout={300}
|
||||
envVars={[
|
||||
{ key: "API_KEY", value: "••••••••••••••••" }
|
||||
]}
|
||||
infoNote={
|
||||
<>
|
||||
Get your API key from{" "}
|
||||
<a href="https://example.com/api-keys" target="_blank" rel="noopener noreferrer">
|
||||
example.com
|
||||
</a>.
|
||||
</>
|
||||
}
|
||||
note="Note that you'll need Node.js installed on your system to run this command, as it uses npx."
|
||||
/>
|
||||
|
||||
## Example Usage
|
||||
|
||||
{describe any environment setup, access controls, and what you want to accomplish.}
|
||||
|
||||
### Goose Prompt
|
||||
|
||||
> _exact prompt_
|
||||
|
||||
|
||||
### Goose Output
|
||||
|
||||
:::note Desktop
|
||||
|
||||
{exact output}
|
||||
|
||||
:::
|
||||
Reference in New Issue
Block a user