|
1 | 1 | # fern-mcp-server |
2 | 2 |
|
3 | | -Install dependencies and start the development server: |
| 3 | +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. |
4 | 4 |
|
5 | | -```shell |
6 | | -npm install |
7 | | -npm start |
8 | | -``` |
| 5 | +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. |
9 | 6 |
|
10 | | -Add the following to your MCP config file: |
| 7 | +> Note: These instructions assume you already have an MCP-compatible AI client installed (Claude Desktop, Cursor, Windsurf, etc.). |
11 | 8 |
|
12 | | -```json |
13 | | -{ |
14 | | - "mcpServers": { |
15 | | - "fern": { |
16 | | - "command": "node", |
17 | | - "args": ["<PATH_TO_PROJECT>/fern-mcp-server/dist/index.js"] |
18 | | - } |
19 | | - } |
20 | | -} |
21 | | -``` |
| 9 | +To get started with the Fern MCP server: |
| 10 | + |
| 11 | +1. Clone this repository and navigate into the `fern-mcp-server` directory. |
| 12 | + |
| 13 | +1. Install dependencies and start the development server: |
| 14 | + |
| 15 | + ```shell |
| 16 | + npm install |
| 17 | + npm start |
| 18 | + ``` |
22 | 19 |
|
23 | | -https://modelcontextprotocol.io/quickstart/user |
| 20 | +1. Add the MCP server configuration to your AI client's config file. The |
| 21 | + location of this file depends on which AI client you're using and your operating |
| 22 | + system. |
| 23 | + |
| 24 | + More information on the exact location of this file and how to |
| 25 | + access or create it: |
24 | 26 |
|
25 | | -https://docs.cursor.com/context/model-context-protocol |
| 27 | + * [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) |
| 28 | + * [Cursor](https://docs.cursor.com/context/model-context-protocol) |
| 29 | + * [Windsurf](https://docs.windsurf.com/windsurf/mcp) |
| 30 | + |
| 31 | +1. Add the following to your MCP config file: |
| 32 | + |
| 33 | + ```json |
| 34 | + { |
| 35 | + "mcpServers": { |
| 36 | + "fern": { |
| 37 | + "command": "node", |
| 38 | + "args": ["<PATH_TO_PROJECT>/fern-mcp-server/dist/index.js"] |
| 39 | + } |
| 40 | + } |
| 41 | + } |
| 42 | + ``` |
| 43 | + Replace `PATH_TO_PROJECT` with your local path to the `fern-mcp-server` project. |
26 | 44 |
|
27 | | -https://docs.windsurf.com/windsurf/mcp |
| 45 | +1. After saving the configuration file, restart your AI client. Once you |
| 46 | + restart, you can test the connection by asking questions like "What MCP servers are available?" or "Can you help me with Fern documentation?" |
28 | 47 |
|
29 | | - |
30 | | - |
| 48 | +  |
| 49 | +  |
0 commit comments