api-documentation-mcp 0.0.0-stage → 0.1.1
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 +46 -2
- package/dist/index.js +21940 -0
- package/package.json +22 -4
package/README.md
CHANGED
|
@@ -1,3 +1,47 @@
|
|
|
1
|
-
#
|
|
1
|
+
# api-documentation-mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Local MCP server for the API Documentation desktop app. It reads the same local SQLite database as the app, so the desktop app must be installed and opened at least once on this computer.
|
|
4
|
+
|
|
5
|
+
## Use with an AI client
|
|
6
|
+
|
|
7
|
+
Add this to your MCP client configuration:
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"mcpServers": {
|
|
12
|
+
"api-documentation": {
|
|
13
|
+
"command": "npx",
|
|
14
|
+
"args": ["-y", "api-documentation-mcp"]
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
For Codex:
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
codex mcp add api-documentation -- npx -y api-documentation-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Requires Node.js 22 or newer.
|
|
27
|
+
|
|
28
|
+
## Data location
|
|
29
|
+
|
|
30
|
+
The server uses the same data folder as the desktop app:
|
|
31
|
+
|
|
32
|
+
- Linux: `~/.config/api-documentation-bit`
|
|
33
|
+
- macOS: `~/Library/Application Support/api-documentation-bit`
|
|
34
|
+
- Windows: `%APPDATA%\api-documentation-bit`
|
|
35
|
+
|
|
36
|
+
Set `API_DOCS_USER_DATA_DIR` in the client configuration if the app uses a custom data folder.
|
|
37
|
+
|
|
38
|
+
## Tools
|
|
39
|
+
|
|
40
|
+
- `list_workspaces`
|
|
41
|
+
- `get_collection_tree`
|
|
42
|
+
- `search_requests`
|
|
43
|
+
- `get_request`
|
|
44
|
+
- `preview_changes`
|
|
45
|
+
- `apply_changes`
|
|
46
|
+
|
|
47
|
+
`apply_changes` writes local drafts. Keep the desktop app open to see changes immediately. Changes are shared only after they are committed and pushed from the desktop app.
|