-
Notifications
You must be signed in to change notification settings - Fork 1
Expand setup instructions in README #2
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,49 @@ | ||
| # fern-mcp-server | ||
|
|
||
| Install dependencies and start the development server: | ||
| Connect AI clients like Claude, Windsurf, and Cursor to the Fern MCP server for help with Fern's AI search (Ask Fern), documentation platform, and SDK generation. | ||
|
|
||
| ```shell | ||
| npm install | ||
| npm start | ||
| ``` | ||
| Once configured, your AI client uses the `ask_fern_ai` command to query Fern's knowledge base, enabling contextual assistance with Fern's tools directly in your development environment. | ||
|
|
||
| Add the following to your MCP config file: | ||
| > Note: These instructions assume you already have an MCP-compatible AI client installed (Claude Desktop, Cursor, Windsurf, etc.). | ||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "fern": { | ||
| "command": "node", | ||
| "args": ["<PATH_TO_PROJECT>/fern-mcp-server/dist/index.js"] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| To get started with the Fern MCP: | ||
|
|
||
| 1. Clone this repository and navigate into the `fern-mcp-server` directory. | ||
|
|
||
| 1. Install dependencies and start the development server: | ||
|
|
||
| ```shell | ||
| npm install | ||
| npm start | ||
| ``` | ||
|
|
||
| https://modelcontextprotocol.io/quickstart/user | ||
| 1. Add the MCP server configuration to your AI client's config file. The | ||
| location of this file depends on which AI client you're using and your operating | ||
| system. | ||
|
|
||
| More information on the exact location of this file and how to | ||
| access or create it: | ||
|
|
||
| https://docs.cursor.com/context/model-context-protocol | ||
| * [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) | ||
| * [Cursor](https://docs.cursor.com/context/model-context-protocol) | ||
| * [Windsurf](https://docs.windsurf.com/windsurf/mcp) | ||
|
|
||
| 1. Add the following to your MCP config file: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "fern": { | ||
| "command": "node", | ||
| "args": ["<PATH_TO_PROJECT>/fern-mcp-server/dist/index.js"] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| Replace `PATH_TO_PROJECT` with your local path to the `fern-mcp-server` project. | ||
|
|
||
| https://docs.windsurf.com/windsurf/mcp | ||
| 1. After saving the configuration file, restart your AI client. Once you | ||
| restart, you can test the connection by asking questions like "What MCP servers are available?" or "Can you help me with Fern documentation?" | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.