Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add MCP Docs #1491

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[docs] Add MCP Docs #1491

wants to merge 7 commits into from

Conversation

wjayesh
Copy link

@wjayesh wjayesh commented Mar 25, 2025

Add MCP Documentation Section with Client Integration Guides

Summary

This PR adds a dedicated MCP (Model Context Protocol) section to the documentation, replacing the previous links in the Resources section with comprehensive guides for integration with various clients (Cursor, Claude, and Windsurf).

Changes

  • Added new MCP section to the navigation with a custom icon
  • Created introduction page explaining MCP concepts and architecture
  • Added detailed integration guides for:
    • Cursor
    • Claude
    • Windsurf
  • Enhanced visual documentation by wrapping videos in Frame components with descriptive captions
  • Temporarily commented out SDK reference section in docs.yml (to be restored in a separate PR)

Visual Improvements

  • Added consistent Frame components around all videos for improved presentation
  • Used proper captioning for videos to improve comprehension

Testing

  • Verified all links and navigation structure
  • Ensured videos display correctly with frames
  • Confirmed markdown formatting is consistent across all documents

This PR is part of our effort to improve documentation organization and provide clearer integration guides for our MCP offering.

@wjayesh wjayesh requested a review from alt-glitch March 25, 2025 10:12
Copy link

vercel bot commented Mar 25, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 25, 2025 11:42am

Copy link

@shreysingla-bot
Copy link
Collaborator

Documentation Review Summary

Overall, the documentation changes are well-structured and comprehensive, providing good coverage of MCP integration across different clients. However, there are a few issues that should be addressed:

Issues Found:

  1. File naming: mcp-cusor.mp4 has a typo and should be renamed to mcp-cursor.mp4
  2. Several typos and grammatical errors in the documentation:
    • "suppport" → "support" in cursor.mdx
    • "provider who have" → "providers who have" in introduction.mdx
    • "scrtch" → "scratch" in blog post URL
  3. Specific instance URL in windsurf.mdx that should be replaced with a placeholder

Suggestions for Improvement:

  1. Consider adding version compatibility information for each client
  2. Add system requirements section
  3. Include error codes and their resolutions
  4. Consider organizing authentication documentation into separate files for better maintainability

Code Quality Rating: 7/10

The documentation is well-organized and comprehensive, but needs some polish in terms of typos, consistency, and structure. The content is valuable and user-friendly, but attention to detail in proofreading would improve the overall quality.

fern/docs.yml Outdated
@@ -332,93 +335,93 @@ navigation:
- api: API Reference
paginated: true

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add the SDK references back. Also, can you update CONTRIBUTING.md for generating the SDK docs

Copy link
Contributor

LGTM 👍

Copy link

Comment on lines +243 to +244
- page: Windsurf
path: mcp/windsurf.mdx
Copy link
Contributor

Choose a reason for hiding this comment

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

Fixed a typo in the path for the Windsurf page. The original path mcp/winsdsurf.mdx had a typo with an extra 's', corrected to mcp/windsurf.mdx.

📝 Committable Code Suggestion

‼️ Ensure you review the code suggestion before committing it to the branch. Make sure it replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- page: Windsurf
path: mcp/windsurf.mdx
path: 'mcp/windsurf.mdx',
name: 'Windsurf',

Copy link

Copy link
Contributor

LGTM 👍

Copy link

Copy link
Contributor

LGTM 👍

Copy link

Copy link
Contributor

LGTM 👍

Copy link

Copy link
Contributor

LGTM 👍

Copy link

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