@docsyncdev/mcp-server 1.0.0 → 1.0.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 +4 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -82,14 +82,6 @@ Search documentation semantically. Returns relevant chunks matching your query.
|
|
|
82
82
|
How does authentication work in this project?
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
### get_document
|
|
86
|
-
|
|
87
|
-
Retrieve full content of a specific document by ID.
|
|
88
|
-
|
|
89
|
-
**Parameters:**
|
|
90
|
-
|
|
91
|
-
- `document_id` (string, required): Document ID from search results
|
|
92
|
-
|
|
93
85
|
### get_docs_for_file ⭐
|
|
94
86
|
|
|
95
87
|
**The killer feature.** Get documentation relevant to a source code file, with full hierarchy context.
|
|
@@ -145,18 +137,16 @@ List all module-level docs
|
|
|
145
137
|
|
|
146
138
|
## Environment Variables
|
|
147
139
|
|
|
148
|
-
| Variable | Required | Description
|
|
149
|
-
| -------------------- | -------- |
|
|
150
|
-
| `DOCSYNC_API_KEY` | Yes | Your DocSync API key
|
|
151
|
-
| `DOCSYNC_PROJECT_ID` | Yes | Your DocSync project ID
|
|
152
|
-
| `DOCSYNC_API_URL` | No | Custom API URL (for development) |
|
|
140
|
+
| Variable | Required | Description |
|
|
141
|
+
| -------------------- | -------- | ----------------------- |
|
|
142
|
+
| `DOCSYNC_API_KEY` | Yes | Your DocSync API key |
|
|
143
|
+
| `DOCSYNC_PROJECT_ID` | Yes | Your DocSync project ID |
|
|
153
144
|
|
|
154
145
|
## Rate Limits
|
|
155
146
|
|
|
156
147
|
- `search_docs`: 200 requests per hour
|
|
157
148
|
- `get_docs_for_file`: 200 requests per hour
|
|
158
149
|
- `list_docs`: 200 requests per hour
|
|
159
|
-
- `get_document`: 500 requests per hour
|
|
160
150
|
|
|
161
151
|
Rate limits are per API key. If you hit a rate limit, the tool will return an error message.
|
|
162
152
|
|
|
@@ -189,20 +179,3 @@ The document ID may be stale if documentation was recently updated. Run a new se
|
|
|
189
179
|
1. Check that your API key is valid in DocSync settings
|
|
190
180
|
2. Verify your project ID is correct
|
|
191
181
|
3. Ensure you have internet connectivity
|
|
192
|
-
|
|
193
|
-
## Development
|
|
194
|
-
|
|
195
|
-
```bash
|
|
196
|
-
# Install dependencies
|
|
197
|
-
npm install
|
|
198
|
-
|
|
199
|
-
# Build
|
|
200
|
-
npm run build
|
|
201
|
-
|
|
202
|
-
# Run locally
|
|
203
|
-
DOCSYNC_API_KEY=your_key DOCSYNC_PROJECT_ID=your_project node dist/index.js
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
## License
|
|
207
|
-
|
|
208
|
-
MIT
|
package/package.json
CHANGED