docs: description required for "Add Extension" in cli #5573

dianed-square · 2025-11-05T01:19:46Z

Summary

This PR updates tutorials to sync with the change to the goose configure flow that requires a description when adding an extension. It also updates the Apify and GitHub tutorials to use install links and changes to lowercase "goose" in touched files.

This is PHASE 1 of the updates for the description requirement and only includes tutorials that use the CLIExtensionInstructions component.

Documentation updates:

Update components:
- documentation/src/components/CLIExtensionInstructions.tsx:
  - Add required description field
- src/components/GooseDesktopInstaller.tsx:
  - Change "OK" to "Yes" to sync with common flow
Add description field to CLI config:
- documentation/docs/mcp/_template_.mdx:
  - Also reorganize and add sse/http examples
- documentation/docs/guides/interactive-chat/mcp-ui.md
- documentation/docs/mcp/apify-mcp.md:
  - Also switch to deeplink install steps
- documentation/docs/mcp/container-use-mcp.md
- documentation/docs/mcp/dev.to-mcp.md
- documentation/docs/mcp/figma-mcp.md
- documentation/docs/mcp/firecrawl-mcp.md
- documentation/docs/mcp/github-mcp.md:
  - Also switch to deeplink install steps
- documentation/docs/mcp/gitmcp-mcp.md
- documentation/docs/mcp/goose-docs-mcp.md
- documentation/docs/mcp/gotohuman-mcp.md
- documentation/docs/mcp/jetbrains-mcp.md
- documentation/docs/mcp/neon-mcp.md
- documentation/docs/mcp/reddit-mcp.md
- documentation/docs/mcp/rube-mcp.md
- documentation/docs/mcp/vercel-mcp.md

Type of Change

Testing

Manual testing of doc rendering plus a couple misc install flows

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1211775814720113
- https://app.asana.com/0/0/1211762596453631

Copilot

Pull Request Overview

This PR standardizes product naming from "Goose" to lowercase "goose" across documentation and updates extension installation instructions to require a description field instead of making it optional.

Changed product name from "Goose" to "goose" throughout documentation
Made the description field required for CLI extension configuration
Updated installation confirmation dialog from "OK" to "Yes"

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`CLIExtensionInstructions.tsx`	Added required `description` prop and updated CLI prompts to require extension descriptions instead of making them optional
`GooseDesktopInstaller.tsx`	Updated installation confirmation button text from "OK" to "Yes"
Multiple `.md` files in `docs/mcp/`	Standardized product name from "Goose" to "goose" in descriptions, headings, and content
`_template_.mdx`	Updated template structure to include required description field and modernized component examples
`mcp-ui.md`	Changed "Goose" to "goose" in description and content

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-05T01:21:42Z

documentation/src/components/CLIExtensionInstructions.tsx

 interface CLIExtensionInstructionsProps {
  name: string;
+  description: string;


The description field is now required in the interface but there's no validation or fallback. Since this is a breaking change to the component API, consider adding a runtime check or default value to prevent runtime errors if existing consumers haven't updated their code yet.

I think this is n/a because it's consistent with the other required fields (no fallback) and this PR updates all existing consumers of this component.

Copilot · 2025-11-05T01:21:43Z

documentation/src/components/CLIExtensionInstructions.tsx

+              ? <>Add {envVars.length > 1 ? 'custom headers' : 'a custom header'} for this extension.</>
+              : <>Add {envVars.length > 1 ? 'environment variables' : 'an environment variable'} for this extension.</>


[nitpick] The refactored text uses 'this extension' instead of the extension name. While this is more generic, it may be less clear to users. The previous version for ${name} provided specific context about which extension was being configured.

Suggested change

? <>Add {envVars.length > 1 ? 'custom headers' : 'a custom header'} for this extension.</>

: <>Add {envVars.length > 1 ? 'environment variables' : 'an environment variable'} for this extension.</>

? <>Add {envVars.length > 1 ? 'custom headers' : 'a custom header'} for <strong>{name}</strong>.</>

: <>Add {envVars.length > 1 ? 'environment variables' : 'an environment variable'} for <strong>{name}</strong>.</>

"this extension" is consistent with other steps and doesn't need specific context. It's also better grammatically.

github-actions · 2025-11-05T01:22:41Z

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-11-05 16:12 UTC

…est-and-fix * 'main' of github.com:block/goose: Document missing recipe param types (#5584) docs: description required for "Add Extension" in cli (#5573) fix: Add schema-aware numeric coercion for MCP tool arguments (#5478) Add uv for uvx in Justfile (#5581) Keep llm logs in place (#5577) bump to 1.12.0 (#5580) automate more of the release process (#5409) add clippy warning for string_slice (#5422)

* main: (41 commits) Add pending extension indicator to extension panel (#5493) Add environment subsition for auth blocks (#5439) acp: ToolCallLocations and working cancellation (#5588) feat(providers): add Mistral AI provider (#5009) Listen for ctrl-c during provider request (#5585) Also accept null as description, not just missing (#5589) Document missing recipe param types (#5584) docs: description required for "Add Extension" in cli (#5573) fix: Add schema-aware numeric coercion for MCP tool arguments (#5478) Add uv for uvx in Justfile (#5581) Keep llm logs in place (#5577) bump to 1.12.0 (#5580) automate more of the release process (#5409) add clippy warning for string_slice (#5422) improve linux tray icon support (#5425) feat: log rotation (#5561) use app.isPackaged instead of checking for node env development (#5465) disable RPM build-ID generation to prevent package conflicts (#5563) Add Diagnostics Info to Q&A and Bug Report Templates (#5565) fix: improve server error messages to include HTTP status code (#5532) ...

* main: (53 commits) acp: ToolCallLocations and working cancellation (#5588) feat(providers): add Mistral AI provider (#5009) Listen for ctrl-c during provider request (#5585) Also accept null as description, not just missing (#5589) Document missing recipe param types (#5584) docs: description required for "Add Extension" in cli (#5573) fix: Add schema-aware numeric coercion for MCP tool arguments (#5478) Add uv for uvx in Justfile (#5581) Keep llm logs in place (#5577) bump to 1.12.0 (#5580) automate more of the release process (#5409) add clippy warning for string_slice (#5422) improve linux tray icon support (#5425) feat: log rotation (#5561) use app.isPackaged instead of checking for node env development (#5465) disable RPM build-ID generation to prevent package conflicts (#5563) Add Diagnostics Info to Q&A and Bug Report Templates (#5565) fix: improve server error messages to include HTTP status code (#5532) improvement: add useful error message when attempting to use unauthenticated cursor-agent (#5300) fix: unblock acp via databricks (#5562) ...

* main: fix: customised recipe to yaml string to avoid minininjia parsing error (#5494) Add pending extension indicator to extension panel (#5493) Add environment subsition for auth blocks (#5439) acp: ToolCallLocations and working cancellation (#5588) feat(providers): add Mistral AI provider (#5009) Listen for ctrl-c during provider request (#5585) Also accept null as description, not just missing (#5589) Document missing recipe param types (#5584) docs: description required for "Add Extension" in cli (#5573) fix: Add schema-aware numeric coercion for MCP tool arguments (#5478) Add uv for uvx in Justfile (#5581) Keep llm logs in place (#5577) bump to 1.12.0 (#5580) automate more of the release process (#5409)

* origin/main: (75 commits) fix: customised recipe to yaml string to avoid minininjia parsing error (#5494) Add pending extension indicator to extension panel (#5493) Add environment subsition for auth blocks (#5439) acp: ToolCallLocations and working cancellation (#5588) feat(providers): add Mistral AI provider (#5009) Listen for ctrl-c during provider request (#5585) Also accept null as description, not just missing (#5589) Document missing recipe param types (#5584) docs: description required for "Add Extension" in cli (#5573) fix: Add schema-aware numeric coercion for MCP tool arguments (#5478) Add uv for uvx in Justfile (#5581) Keep llm logs in place (#5577) bump to 1.12.0 (#5580) automate more of the release process (#5409) add clippy warning for string_slice (#5422) improve linux tray icon support (#5425) feat: log rotation (#5561) use app.isPackaged instead of checking for node env development (#5465) disable RPM build-ID generation to prevent package conflicts (#5563) Add Diagnostics Info to Q&A and Bug Report Templates (#5565) ...

Signed-off-by: fbalicchia <[email protected]>

Signed-off-by: Blair Allan <[email protected]>

dianed-square added 3 commits November 4, 2025 16:14

update component and template; switch http manual steps to install link

a4a829d

add description to CLI config

7a3bc54

make description required

586cb9f

dianed-square requested a review from a team as a code owner November 5, 2025 01:19

Copilot AI review requested due to automatic review settings November 5, 2025 01:19

Copilot AI reviewed Nov 5, 2025

View reviewed changes

blackgirlbytes approved these changes Nov 5, 2025

View reviewed changes

dianed-square merged commit efdf22e into main Nov 5, 2025
21 checks passed

github-actions bot mentioned this pull request Nov 6, 2025

chore(release): release version 1.13.1 (patch) #5619

Merged

fbalicchia pushed a commit to fbalicchia/goose that referenced this pull request Nov 7, 2025

docs: description required for "Add Extension" in cli (block#5573)

f28fade

Signed-off-by: fbalicchia <[email protected]>

github-actions bot mentioned this pull request Nov 11, 2025

chore(release): release version 1.14.0 (minor) #5676

Merged

BlairAllan pushed a commit to BlairAllan/goose that referenced this pull request Nov 29, 2025

docs: description required for "Add Extension" in cli (block#5573)

50c2d44

Signed-off-by: Blair Allan <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: description required for "Add Extension" in cli #5573

docs: description required for "Add Extension" in cli #5573

Uh oh!

dianed-square commented Nov 5, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 5, 2025

Uh oh!

dianed-square Nov 5, 2025

Uh oh!

Copilot AI Nov 5, 2025

Uh oh!

dianed-square Nov 5, 2025

Uh oh!

github-actions bot commented Nov 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		? <>Add {envVars.length > 1 ? 'custom headers' : 'a custom header'} for this extension.</>
		: <>Add {envVars.length > 1 ? 'environment variables' : 'an environment variable'} for this extension.</>

docs: description required for "Add Extension" in cli #5573

docs: description required for "Add Extension" in cli #5573

Uh oh!

Conversation

dianed-square commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Type of Change

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

dianed-square Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

dianed-square Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dianed-square commented Nov 5, 2025 •

edited

Loading

github-actions bot commented Nov 5, 2025 •

edited

Loading