Skip to content

Conversation

@dianed-square
Copy link
Contributor

Summary

This PR updates extension tutorials to standardize CLI setup instructions and migrate to components

Key Changes:

  • Migrate extension tutorials with full-text CLI steps to CLIExtensionInstructions component
  • Add a commandNote prop to CLIExtensionInstructions (similar to infoNote for env vars/header step but for command/url step)
  • Update Add Extension flow used by built-in extension tutorials to Toggle Extension flow
  • Misc changes: lowercase "goose", config updates for consistency, add npx/uvx prereq notes

Type of Change

  • Feature
  • Bug fix
  • Refactor / Code quality
  • Performance improvement
  • Documentation
  • Tests
  • Security fix
  • Build / Release
  • Other (specify below)

Testing

Manual review of steps, some install tests

@dianed-square dianed-square requested a review from a team as a code owner November 7, 2025 19:42
Copilot AI review requested due to automatic review settings November 7, 2025 19:42
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes documentation for MCP server extensions by consolidating CLI installation instructions into a reusable component and normalizing the casing of "Goose" to "goose" throughout the documentation. The key changes include:

  • Replacing lengthy, repetitive CLI configuration steps with the CLIExtensionInstructions component across all MCP extension docs
  • Updating "Goose" to lowercase "goose" in descriptive text while preserving capitalization in proper names and UI elements
  • Adding a commandNote prop to CLIExtensionInstructions for displaying contextual information about commands/URLs
  • Updating the OpenMetadata link in servers.json from the marketing page to the GitHub repository

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

File Description
documentation/src/components/CLIExtensionInstructions.tsx Added commandNote prop to display contextual information for command/URL configuration step
documentation/static/servers.json Updated OpenMetadata link from marketing page to GitHub repository
Multiple documentation/docs/mcp/*.md files Replaced verbose CLI instructions with CLIExtensionInstructions component; standardized "goose" casing
Comments suppressed due to low confidence (1)

documentation/src/components/CLIExtensionInstructions.tsx:165

  • Inconsistent casing: 'Goose' should be 'goose' to match the standardization applied throughout this PR.

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

<Tabs groupId="interface">
<TabItem value="ui" label="goose Desktop" default>
[Launch the installer](goose://extension?cmd=npx&arg=-y&arg=mcp-remote&arghttp://localhost:8585/mcp&arg=--auth-server-url&arg=http://localhost:8585/mcp&id=openmetadata&name=OpenMetadata&description=OpenMetadata%20integration)
[Launch the installer](goose://extension?cmd=npx&arg=-y&arg=mcp-remote&arg=http%3A%2F%2Flocalhost%3A8585%2Fmcp&arg=--auth-server-url%3Dhttp%3A%2F%2Flocalhost%3A8585%2Fmcp&arg=--client-id%3Dopenmetadata&arg=--verbose&arg=--clean&arg=--header&arg=Authorization%3A%24%7BAUTH_HEADER%7D&id=openmetadata&name=OpenMetadata&description=Intelligent%20data%20management%20and%20automated%20data%20operations&env=AUTH_HEADER%3DBearer%20YOUR_OPENMETADATA_PAT)
Copy link

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The deep-link URL is extremely long and difficult to read/maintain. Consider breaking this into multiple lines or extracting the URL parameters into a more maintainable format.

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-11-07 21:30 UTC

@dianed-square dianed-square merged commit 65b4b2b into main Nov 7, 2025
22 checks passed
michaelneale added a commit that referenced this pull request Nov 10, 2025
* main: (33 commits)
  Fix Claude Code provider to default to Auto mode (#5638) (#5642)
  Scheduler cleanup (#5571)
  Better search paths and handling of CLI providers (#5554)
  docs: description required for "Add Extension" in cli - phase 2 (#5635)
  Remove some logging (#5631)
  Use session IDs as task IDs for subagents instead of UUIDs (#5398)
  Fix the naming (#5628)
  fix: default tetrate model is broken, replace with haiku-4.5 (#5535) (#5587)
  Fetch less and use the right SHA (#5621)
  feat(ui): add custom macOS dock menu with New Window option (#5099)
  feat: remove hints from recipe prompts (#5622)
  docs: October 2025 Community All-Stars spotlight, Hacktoberfest edition (#5625)
  differentiate debug/release in cache key (#5613)
  Unify subrecipe and subagent execution through shared recipe pipeline (#5082)
  Standardize CLI argument flags and update documentation (#5516)
  Release 1.13.0
  fix: move goosehints/AGENTS.md handling to goose, and out of developer extension (#5575)
  fix: add standard context menu items to prevent empty right-click menu (#5616)
  Bump openapi in prepare-release (#5611)
  docs: add access control section to Developer tutorial (#5615)
  ...
tiensi added a commit to tiensi/goose that referenced this pull request Nov 11, 2025
* main: (83 commits)
  silence copilot on minor text issues (block#5665)
  fix: disallow runaway subagent chains (block#5659)
  chore: remove usage of non-existent env var for log dir (block#5658)
  clarify agent instructions (block#5655)
  feat: add check-everything for unified style checks (block#5650)
  Show errors on failure (block#5643)
  custom instructions for copilot reviews (block#5646)
  fix: prevent repeated 404 errors when accessing deleted sessions (block#5644)
  Flake.nix corrected main (block#5600)
  fix: goose recipe list can return duplicated entries (block#5645)
  fix: bedrock creds refresh (block#5599)
  Fix Claude Code provider to default to Auto mode (block#5638) (block#5642)
  Scheduler cleanup (block#5571)
  Better search paths and handling of CLI providers (block#5554)
  docs: description required for "Add Extension" in cli - phase 2 (block#5635)
  Remove some logging (block#5631)
  Use session IDs as task IDs for subagents instead of UUIDs (block#5398)
  Fix the naming (block#5628)
  fix: default tetrate model is broken, replace with haiku-4.5 (block#5535) (block#5587)
  Fetch less and use the right SHA (block#5621)
  ...
Surendhar-N-D pushed a commit to Surendhar-N-D/goose that referenced this pull request Nov 17, 2025
arul-cc pushed a commit to arul-cc/goose that referenced this pull request Nov 17, 2025
BlairAllan pushed a commit to BlairAllan/goose that referenced this pull request Nov 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants