Skip to content

Conversation

@dianed-square
Copy link
Contributor

@dianed-square dianed-square commented Jan 17, 2026

Summary

This PR adds a recipe to help external contributors add their MCP server to the goose documentation. Has knowledge needed to help create/review the servers.json entry and tutorial file.

What it does

  • Step-by-step information gathering (STDIO vs HTTP, env vars, headers, etc.)
  • Generates properly formatted servers.json entries and draft tutorial file with components (basic template)
  • Checks technical requirements (correct fields for type, matching deeplinks, etc.)
  • Catches common mistakes before submission (missing -y flag, wrong filename, etc.)

Testing

  • ✅ Tested in goose Desktop with dummy and real MCP servers covering all major patterns (STDIO/HTTP, env vars/headers, empty arrays)
  • ✅ All deeplinks validated (Extension card, TLDR, Desktop config all match)

Changes

  • documentation/src/pages/recipes/data/recipes/add-mcp-server.yaml
    • New recipe
  • documentation/docs/mcp/_template_.mdx
    • Mention recipe exists
  • documentation/src/components/recipe-card.tsx and documentation/src/pages/recipes/detail.tsx:
    • Handle "message" activity types (hide on index card, display in info box on details card)

Type of Change

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

AI Assistance

  • This PR was created or reviewed with AI assistance

Testing

Manual testing


@dianed-square dianed-square requested a review from a team as a code owner January 17, 2026 00:43
Copilot AI review requested due to automatic review settings January 17, 2026 00:43
@github-actions
Copy link
Contributor

🔍 Recipe Security Scan Results

Status: APPROVED - All recipes passed security scan

📊 Scan Summary:

  • Total recipes scanned: 1

📋 Individual Recipe Results:
✅ Recipe 1: APPROVED (LOW risk)

🔗 View detailed scan results in the workflow artifacts.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 17, 2026

PR Preview Action v1.6.3
Preview removed because the pull request was closed.
2026-01-20 16:52 UTC

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 introduces a new recipe that helps external contributors add their MCP servers to the goose documentation. The recipe guides users through creating properly formatted servers.json entries and tutorial files, with validation to catch common mistakes before submission.

Changes:

  • Adds a comprehensive "Add MCP Server" recipe with step-by-step instructions for creating documentation
  • Implements "message:" activity type support to display rich markdown welcome messages in recipe cards
  • Updates template file to reference the new recipe

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
documentation/src/pages/recipes/data/recipes/add-mcp-server.yaml New recipe providing guided workflow for adding MCP servers to documentation with validation rules
documentation/src/pages/recipes/detail.tsx Adds ReactMarkdown rendering for "message:" activities in info boxes and filters them from pill display
documentation/src/components/recipe-card.tsx Filters out "message:" activities from index card pill display
documentation/docs/mcp/_template_.mdx Adds comment mentioning the new recipe for contributor convenience

Copy link
Collaborator

@angiejones angiejones left a comment

Choose a reason for hiding this comment

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

nice!

@dianed-square dianed-square merged commit bd84da2 into main Jan 20, 2026
29 checks passed
@dianed-square dianed-square deleted the recipes/add-mcp-server branch January 20, 2026 16:50
michaelneale added a commit that referenced this pull request Jan 21, 2026
* main:
  increase worker threads for ci (#6614)
  docs: todo tutorial update (#6613)
  Added goose doc map md file for goose agent to find relevant doc easily. (#6598)
  add back goose branding to home (#6617)
  fix: actually set the working dir for extensions from session (#6612)
  Multi chat (#6428)
  Lifei/fixed accumulated token count (#6587)
  Dont show MCP UI/Apps until tool is approved (#6492)
  docs: max tokens config (#6596)
  User configurable templates (#6420)
  docs: http proxy environment variables (#6594)
  feat: exclude subagent tool from code_execution filtering (#6531)
  Fix path for global agent skills (#6591)
  recipes: add mcp server (#6552)
  feat(gcp-vertex): add model list with org policy filtering (#6393)
  chore: encourage extension searching (#6582)
  blog: mobile apps consolidation and roadmap (#6580)
  chore: remove unused dependencies in cargo.toml (#6561)
  resolved all the extensions to load in cli (#6464)
lifeizhou-ap added a commit that referenced this pull request Jan 22, 2026
* main: (41 commits)
  chore: tweak release docs (#6571)
  fix(goose): propagate session_id across providers and MCP (#6584)
  increase worker threads for ci (#6614)
  docs: todo tutorial update (#6613)
  Added goose doc map md file for goose agent to find relevant doc easily. (#6598)
  add back goose branding to home (#6617)
  fix: actually set the working dir for extensions from session (#6612)
  Multi chat (#6428)
  Lifei/fixed accumulated token count (#6587)
  Dont show MCP UI/Apps until tool is approved (#6492)
  docs: max tokens config (#6596)
  User configurable templates (#6420)
  docs: http proxy environment variables (#6594)
  feat: exclude subagent tool from code_execution filtering (#6531)
  Fix path for global agent skills (#6591)
  recipes: add mcp server (#6552)
  feat(gcp-vertex): add model list with org policy filtering (#6393)
  chore: encourage extension searching (#6582)
  blog: mobile apps consolidation and roadmap (#6580)
  chore: remove unused dependencies in cargo.toml (#6561)
  ...
fbalicchia pushed a commit to fbalicchia/goose that referenced this pull request Jan 23, 2026
Signed-off-by: fbalicchia <fbalicchia@cuebiq.com>
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