diff --git a/documentation/docs/getting-started/using-extensions.md b/documentation/docs/getting-started/using-extensions.md index 6fe82efc35..8886673f12 100644 --- a/documentation/docs/getting-started/using-extensions.md +++ b/documentation/docs/getting-started/using-extensions.md @@ -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= 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). diff --git a/documentation/docs/guides/goose-cli-commands.md b/documentation/docs/guides/goose-cli-commands.md index e863f1fc7c..cebe9e3ae2 100644 --- a/documentation/docs/guides/goose-cli-commands.md +++ b/documentation/docs/guides/goose-cli-commands.md @@ -58,15 +58,15 @@ goose session --name - **`-r, --resume`** -Resume a previous session (last used or specified by `--name`) +Resume the previous session ```bash -goose session --name --resume +goose session --resume ``` - **`--with-extension `** -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 --with-extension @@ -77,7 +77,7 @@ goose session --name --with-extension 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 +goose session --with-builtin ``` ### run [options] diff --git a/documentation/docs/troubleshooting.md b/documentation/docs/troubleshooting.md index 08639262af..f40aebdf37 100644 --- a/documentation/docs/troubleshooting.md +++ b/documentation/docs/troubleshooting.md @@ -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]! diff --git a/documentation/docs/tutorials/figma-mcp.md b/documentation/docs/tutorials/figma-mcp.md index b1bd814125..e13c6111f7 100644 --- a/documentation/docs/tutorials/figma-mcp.md +++ b/documentation/docs/tutorials/figma-mcp.md @@ -23,6 +23,10 @@ FIGMA_ACCESS_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 diff --git a/documentation/docs/tutorials/github-mcp.md b/documentation/docs/tutorials/github-mcp.md index aa74bcef8c..7bc8fdc6ab 100644 --- a/documentation/docs/tutorials/github-mcp.md +++ b/documentation/docs/tutorials/github-mcp.md @@ -24,6 +24,10 @@ GITHUB_PERSONAL_ACCESS_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