Skip to content

Commit 7d2de3d

Browse files
authored
Merge pull request #2 from devalog/readme-edits
Expand setup instructions in README
2 parents 362f1ff + 8e65c8e commit 7d2de3d

File tree

1 file changed

+40
-21
lines changed

1 file changed

+40
-21
lines changed

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,49 @@
11
# fern-mcp-server
22

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.
44

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.
96

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.).
118
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+
```
2219

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:
2426

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.
2644

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?"
2847

29-
![Screenshot 1](static/screenshot-1.png)
30-
![Screenshot 2](static/screenshot-2.png)
48+
![Claude Desktop successfully integrated with Fern MCP](static/screenshot-1.png)
49+
![How Claude Desktop uses Fern MCP to provide information](static/screenshot-2.png)

0 commit comments

Comments
 (0)