react-docs-mcp 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,9 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
AI-powered semantic search over React documentation for Claude, Cursor, and other MCP clients.
|
|
8
8
|
|
|
9
|
+
<p align="center">
|
|
10
|
+
<img src="./demo.gif" width="100%" alt="React Docs MCP Demo">
|
|
11
|
+
</p>
|
|
12
|
+
|
|
9
13
|
## 🚀 Installation (One Command)
|
|
10
14
|
|
|
11
15
|
### Claude Code
|
|
16
|
+
|
|
12
17
|
```bash
|
|
13
18
|
claude mcp add --transport stdio react-docs -- npx react-docs-mcp
|
|
14
19
|
```
|
|
@@ -30,12 +35,15 @@ Edit: `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
|
|
|
30
35
|
|
|
31
36
|
### Cursor
|
|
32
37
|
|
|
33
|
-
**Settings** → **
|
|
38
|
+
**Settings** → **Cursor settings** → **Tools and MCP** → Add server:
|
|
39
|
+
|
|
34
40
|
```json
|
|
35
41
|
{
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
-
|
|
42
|
+
"mcpServers": {
|
|
43
|
+
"react-docs": {
|
|
44
|
+
"command": "npx",
|
|
45
|
+
"args": ["-y", "react-docs-mcp"]
|
|
46
|
+
}
|
|
39
47
|
}
|
|
40
48
|
}
|
|
41
49
|
```
|
|
@@ -99,11 +107,13 @@ Once configured, the server provides the following capabilities to AI agents:
|
|
|
99
107
|
Search across React documentation.
|
|
100
108
|
|
|
101
109
|
**Parameters**:
|
|
110
|
+
|
|
102
111
|
- `query` (required): Search query string
|
|
103
112
|
- `section` (optional): Filter by section (learn, reference, blog, community)
|
|
104
113
|
- `limit` (optional): Maximum number of results (default: 10, max: 50)
|
|
105
114
|
|
|
106
115
|
**Example**:
|
|
116
|
+
|
|
107
117
|
```
|
|
108
118
|
Search for "useState hook" in the learn section
|
|
109
119
|
```
|
|
@@ -113,9 +123,11 @@ Search for "useState hook" in the learn section
|
|
|
113
123
|
Get a specific documentation page.
|
|
114
124
|
|
|
115
125
|
**Parameters**:
|
|
126
|
+
|
|
116
127
|
- `path` (required): Document path (e.g., "learn/hooks/useState")
|
|
117
128
|
|
|
118
129
|
**Example**:
|
|
130
|
+
|
|
119
131
|
```
|
|
120
132
|
Get the useState documentation
|
|
121
133
|
```
|
|
@@ -125,6 +137,7 @@ Get the useState documentation
|
|
|
125
137
|
List all available documentation sections.
|
|
126
138
|
|
|
127
139
|
**Example**:
|
|
140
|
+
|
|
128
141
|
```
|
|
129
142
|
What sections are available?
|
|
130
143
|
```
|
|
@@ -134,6 +147,7 @@ What sections are available?
|
|
|
134
147
|
Pull latest documentation from the Git repository.
|
|
135
148
|
|
|
136
149
|
**Example**:
|
|
150
|
+
|
|
137
151
|
```
|
|
138
152
|
Update the React documentation
|
|
139
153
|
```
|
|
@@ -147,6 +161,7 @@ react-docs://{section}/{path}
|
|
|
147
161
|
```
|
|
148
162
|
|
|
149
163
|
**Examples**:
|
|
164
|
+
|
|
150
165
|
- `react-docs://learn` - List all learn section docs
|
|
151
166
|
- `react-docs://learn/hooks/useState` - Get useState documentation
|
|
152
167
|
- `react-docs://reference/react/Component` - Get Component API reference
|
|
@@ -176,8 +191,6 @@ reactDocsMcp/
|
|
|
176
191
|
│ ├── searchEngine.ts # Search implementation
|
|
177
192
|
│ ├── types.ts # TypeScript types
|
|
178
193
|
│ └── config.ts # Configuration
|
|
179
|
-
├── data/
|
|
180
|
-
│ └── react-dev-repo/ # Cloned React docs (auto-created)
|
|
181
194
|
├── dist/ # Compiled output
|
|
182
195
|
└── TECHNICAL_SPEC.md # Technical documentation
|
|
183
196
|
```
|