docs: package runner info (#1172)

This commit is contained in:
Angie Jones
2025-02-10 12:04:25 -06:00
committed by GitHub
parent 3a148c9bc1
commit 217df5200b
5 changed files with 32 additions and 4 deletions

View File

@@ -285,6 +285,7 @@ For example, to start a session with the [Fetch extension](https://github.com/mo
goose session --with-extension "uvx mcp-server-fetch"
```
#### Environment Variables
Some extensions require environment variables. You can include these in your command:
@@ -299,6 +300,10 @@ For example, to start a session with the [GitHub extension](https://github.com/m
goose session --with-extension "GITHUB_PERSONAL_ACCESS_TOKEN=<YOUR_TOKEN> npx -y @modelcontextprotocol/server-github"
```
:::info
Note that you'll need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses npx.
:::
## Developing Extensions
Goose extensions are implemented with MCP, a standard protocol that allows AI models and agents to securely connect with local or remote resources. Learn how to build your own [extension as an MCP server](https://modelcontextprotocol.io/quickstart/server).

View File

@@ -58,15 +58,15 @@ goose session --name <name>
- **`-r, --resume`**
Resume a previous session (last used or specified by `--name`)
Resume the previous session
```bash
goose session --name <name> --resume
goose session --resume
```
- **`--with-extension <COMMAND>`**
Starts the session with the specified extension. Can also include environment variables (e.g., `'GITHUB_TOKEN=xyz npx -y @modelcontextprotocol/server-github'`).
Starts the session with the specified extension. Can also include environment variables (e.g., `'GITHUB_TOKEN={your_token} npx -y @modelcontextprotocol/server-github'`).
```bash
goose session --name <name> --with-extension <command>
@@ -77,7 +77,7 @@ goose session --name <name> --with-extension <command>
Starts the session with the specified [built-in extension](/docs/getting-started/using-extensions#built-in-extensions) enabled. (e.g. 'developer')
```bash
goose session --with-builtin <name>
goose session --with-builtin <id>
```
### run [options]

View File

@@ -157,6 +157,21 @@ Welcome to goose! Let's get you set up with a provider.
---
### Package Runners
Many of the external extensions require a package runner. For example, if you run into an error like this one:
```
Failed to start extension: {extension name}, "No such file or directory (os error 2)"
Please check extension configuration for {extension name}.
```
... it signals that the extension may not have been installed and you need the package runner in order to do so.
An example is the GitHub extension whose command is `npx -y @modelcontextprotocol/server-github`. You'd need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses npx.
---
### Need Further Help?
If you have questions, run into issues, or just need to brainstorm ideas join the [Discord Community][discord]!

View File

@@ -23,6 +23,10 @@ FIGMA_ACCESS_TOKEN: <YOUR_TOKEN>
```
:::
:::info
Note that you'll need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses npx.
:::
## Configuration
<Tabs groupId="interface">

View File

@@ -24,6 +24,10 @@ GITHUB_PERSONAL_ACCESS_TOKEN: <YOUR_TOKEN>
```
:::
:::info
Note that you'll need [Node.js](https://nodejs.org/) installed on your system to run this command, as it uses npx.
:::
## Configuration
<Tabs groupId="interface">