-
Notifications
You must be signed in to change notification settings - Fork 3
Update MCP server documentation to describe auto-generated functionality #1720
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
base: main
Are you sure you want to change the base?
Update MCP server documentation to describe auto-generated functionality #1720
Conversation
…tionality Co-Authored-By: [email protected] <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
| <Tip> | ||
| **Looking for Fern's own MCP server?** If you want to connect your AI client to Fern's MCP server for help with Ask Fern, Docs, and SDKs, see the [fern-mcp-server repository](https://github.com/fern-api/fern-mcp-server). | ||
| </Tip> | ||
| ## Accessing your MCP server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Accessing your MCP server' should use sentence-style capitalization.
|
|
||
| ## Features | ||
|
|
||
| The auto-generated MCP server includes: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Auto] In general, don't hyphenate 'auto-generated'.
|
|
||
| - **Semantic search**: Powered by your site's Ask Fern AI functionality | ||
| - **Authentication support**: Respects your documentation's authentication settings | ||
| - **Automatic updates**: Always reflects your latest documentation content |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| <Tip> | ||
| **Looking for Fern's own MCP server?** If you want to connect your AI client to Fern's MCP server for help with Ask Fern, Docs, and SDKs, see the [fern-mcp-server repository](https://github.com/fern-api/fern-mcp-server). | ||
| </Tip> | ||
| ## Access your MCP server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Access your MCP server' should use sentence-style capitalization.
Update MCP server documentation to describe auto-generated functionality
Summary
Updated the MCP server documentation to describe Fern's auto-generated MCP server functionality instead of linking to the external
fern-api/fern-mcp-serverrepository. The changes include:/docs/ai/mcp-serverpage: Rewrote the content to explain that Fern automatically generates and hosts an MCP server for every documentation site, describing how it works, how to access it, and its features/mcpto/_mcp/serverbased on the middleware implementation in fern-platformThe documentation now explains that the MCP server:
searchDocstool powered by Ask Fern AIyour-documentation-site.com/_mcp/serverReview & Testing Checklist for Human
/_mcp/serveron a live Fern docs site to confirm this is the correct public-facing URL (I found this in the middleware code but couldn't test it)/docs/ai/mcp-serverresolves correctly when the documentation is publishedfern-api/fern-mcp-serverthat should be removed or updatedNotes
/mcpto/_mcp/serverbased on the middleware.ts implementation at line 175-178Link to Devin run: https://app.devin.ai/sessions/ff3bcad83fc9458989fac948b0838de8
Requested by: [email protected] (@dannysheridan)