Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

docs: add mcp integration guide for suga docs mcp server#129

Merged
jyecusch merged 2 commits intomainfrom
docs/suga-mcp
Oct 22, 2025
Merged

docs: add mcp integration guide for suga docs mcp server#129
jyecusch merged 2 commits intomainfrom
docs/suga-mcp

Conversation

@tjholm
Copy link
Member

@tjholm tjholm commented Oct 21, 2025

No description provided.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025

📝 Walkthrough

Walkthrough

This PR adds a new MCP (Model Context Protocol) integration guide to the docs: a navigation entry in docs/docs.json, a Featured Guides card in docs/guides.mdx linking to the page, the new guide file docs/guides/mcp-integration.mdx with integration steps and examples for Claude Code, Cursor, and Windsurf, and a new accepted vocabulary term mcpServers in docs/.vale/styles/config/vocabularies/Suga/accept.txt. No code or public API changes.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • HomelessDinosaur
  • jyecusch
  • raksiv
  • sean-nitric

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description Check ❓ Inconclusive No pull request description was provided by the author. While the title is clear and the changes relate to adding MCP integration documentation, the complete absence of any description makes it impossible to verify whether contextual details or reasoning are documented. Given the lenient nature of this check, a missing description creates ambiguity about whether the author intended to communicate additional context about the changeset. Consider adding a brief PR description to explain the motivation and scope of the MCP integration guide, even if minimal. This helps reviewers understand the context and any related considerations for the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The title "docs: add mcp integration guide for suga docs mcp server" accurately and clearly describes the primary change in this PR. The changeset is entirely focused on adding MCP integration documentation—a new guide file (mcp-integration.mdx), corresponding navigation entries, and vocabulary updates. The title is specific and concise, avoiding vague terms or unnecessary details, and uses the conventional "docs:" scope prefix. A reviewer scanning the history would immediately understand that this PR introduces MCP integration guidance.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/guides/mcp-integration.mdx (1)

27-73: Claude Code instructions are clear, but clarify .mcp.json scope.

The CLI command, verification step, and usage examples are practical. However, lines 58–70 assume knowledge of where the .mcp.json file belongs (project root? shared config directory?). Consider adding a note about file placement and whether this is user-level or project-level configuration.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca3f133 and 50cba95.

📒 Files selected for processing (3)
  • docs/docs.json (1 hunks)
  • docs/guides.mdx (1 hunks)
  • docs/guides/mcp-integration.mdx (1 hunks)
🔇 Additional comments (8)
docs/docs.json (1)

33-33: Navigation entry is well-placed and consistent.

The new guide path is correctly positioned in the Guides group and matches the corresponding href in docs/guides.mdx and the actual file location.

docs/guides.mdx (1)

21-28: Featured Guide card is consistent with existing cards.

The component follows the same structure as adjacent cards, and the href aligns with the navigation entry added to docs.json. Icon and description are fitting.

docs/guides/mcp-integration.mdx (6)

1-8: Frontmatter and overview are well-aligned with the guides index.

The title and description match the Featured Guide card in docs/guides.mdx, and the MCP explanation is clear and accessible for users unfamiliar with the protocol.


10-20: MCP server URL and capabilities are clearly presented.

The content provides the endpoint and a concise summary of server capabilities. However, verify the MCP server URL (https://docs.addsuga.com/mcp) is actually live and functional.


76-105: Cursor setup instructions follow a UI-based pattern well.

The Settings path and configuration structure are clear. Verify the documentation link (line 105) is current, as Cursor's UI and feature locations can change between versions.


110-136: Windsurf tab is concise, but documentation link should be verified.

The setup instructions are straightforward. Verify the Windsurf documentation URL (line 135) is correct and that "Cascade AI" is the accurate term for the feature that will query the MCP server.


141-145: Learn More section provides good follow-up resources.

The links to MCP documentation, CLI reference, and quickstart guide are contextually relevant and well-chosen.


60-68: No action needed. Configuration keys are correct and tool-specific.

The documentation accurately reflects each tool's actual MCP server configuration requirements:

  • Windsurf uses serverUrl
  • Claude Code and Cursor use url

These are properly separated in labeled tabs, preventing misconfigurations. The inconsistency is intentional and correct per tool specifications.

Likely an incorrect or invalid review comment.

@jyecusch jyecusch changed the title docs(docs): add mcp integration guide for suga docs mcp server docs: add mcp integration guide for suga docs mcp server Oct 22, 2025
@jyecusch jyecusch merged commit 098f0eb into main Oct 22, 2025
5 of 6 checks passed
@jyecusch jyecusch deleted the docs/suga-mcp branch October 22, 2025 00:13
@nitric-bot
Copy link

🎉 This PR is included in version 0.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants