-
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?
Changes from 1 commit
8c2de12
64445a8
2da2b0c
b1647a2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,14 +7,30 @@ description: Learn how to use the Model Context Protocol (MCP) to integrate AI c | |
|
|
||
| [Model Context Protocol (MCP)](https://modelcontextprotocol.io) is an open standard by Anthropic that enables AI applications to connect with external data sources and tools. | ||
|
|
||
| Fern can build a production-ready MCP server for your documentation site. This enables developers using AI clients (like Claude Desktop, Cursor, and Windsurf) to get instant answers about your product directly within their development environment. | ||
| Fern automatically generates and hosts a production-ready MCP server for every documentation site. This enables developers using AI clients (like Claude Desktop, Cursor, and Windsurf) to get instant answers about your product directly within their development environment. | ||
|
|
||
| ## How it works | ||
|
|
||
| Fern analyzes your docs site structure and content, then creates an MCP server. | ||
| Fern automatically creates an MCP server for your documentation site that provides a `searchDocs` tool. This tool uses your site's Ask Fern AI search functionality to answer questions about your documentation. | ||
|
|
||
| Developers can access your MCP server by visiting `your-documentation-site.com/mcp` and copying the configuration snippet to add to their AI client settings. Once integrated, developers can ask their AI client questions about your products. The AI client will search through your documentation and provide accurate answers. | ||
| When developers connect to your MCP server, they can ask questions about your product, and the AI client will search through your documentation using semantic search and provide accurate, contextual answers. | ||
|
|
||
| <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 | ||
|
|
||
| Your MCP server is automatically available at `your-documentation-site.com/_mcp/server`. Developers can configure their AI clients to connect to this endpoint. | ||
|
|
||
| To use your MCP server: | ||
|
|
||
| 1. Visit `your-documentation-site.com/_mcp/server` in a browser to see the server information | ||
| 2. Configure your AI client (Claude Desktop, Cursor, Windsurf, etc.) to connect to this URL | ||
| 3. Authenticate if your documentation requires authentication | ||
| 4. Start asking questions about your product directly in your AI client | ||
|
|
||
| ## Features | ||
|
|
||
| The auto-generated MCP server includes: | ||
|
||
|
|
||
| - **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 | ||
|
||
| - **Zero configuration**: Works out of the box with no setup required | ||
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.