@arabold/docs-mcp-server 1.7.0 → 1.9.0
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 +25 -3
- package/dist/{chunk-FAZDXJQN.js → chunk-A5FW7XVC.js} +346 -265
- package/dist/chunk-A5FW7XVC.js.map +1 -0
- package/dist/cli.js +38 -4
- package/dist/cli.js.map +1 -1
- package/dist/server.js +38 -13
- package/dist/server.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-FAZDXJQN.js.map +0 -1
package/README.md
CHANGED
|
@@ -25,6 +25,7 @@ The server exposes MCP tools for:
|
|
|
25
25
|
- Listing indexed libraries (`list_libraries`).
|
|
26
26
|
- Finding appropriate versions (`find_version`).
|
|
27
27
|
- Removing indexed documents (`remove_docs`).
|
|
28
|
+
- Fetching single URLs (`fetch_url`): Fetches a URL and returns its content as Markdown.
|
|
28
29
|
|
|
29
30
|
## Configuration
|
|
30
31
|
|
|
@@ -250,11 +251,31 @@ npx -y --package=@arabold/docs-mcp-server docs-cli --help
|
|
|
250
251
|
```bash
|
|
251
252
|
docs-cli scrape --help
|
|
252
253
|
docs-cli search --help
|
|
254
|
+
docs-cli fetch-url --help
|
|
253
255
|
docs-cli find-version --help
|
|
254
256
|
docs-cli remove --help
|
|
255
257
|
docs-cli list --help
|
|
256
258
|
```
|
|
257
259
|
|
|
260
|
+
### Fetching Single URLs (`fetch-url`)
|
|
261
|
+
|
|
262
|
+
Fetches a single URL and converts its content to Markdown. Unlike `scrape`, this command does not crawl links or store the content.
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
docs-cli fetch-url <url> [options]
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
**Options:**
|
|
269
|
+
|
|
270
|
+
- `--no-follow-redirects`: Disable following HTTP redirects (default: follow redirects)
|
|
271
|
+
|
|
272
|
+
**Examples:**
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
# Fetch a URL and convert to Markdown
|
|
276
|
+
docs-cli fetch-url https://example.com/page.html
|
|
277
|
+
```
|
|
278
|
+
|
|
258
279
|
### Scraping Documentation (`scrape`)
|
|
259
280
|
|
|
260
281
|
Scrapes and indexes documentation from a given URL for a specific library.
|
|
@@ -268,7 +289,7 @@ docs-cli scrape <library> <url> [options]
|
|
|
268
289
|
- `-v, --version <string>`: The specific version to associate with the scraped documents.
|
|
269
290
|
- Accepts full versions (`1.2.3`), pre-release versions (`1.2.3-beta.1`), or partial versions (`1`, `1.2` which are expanded to `1.0.0`, `1.2.0`).
|
|
270
291
|
- If omitted, the documentation is indexed as **unversioned**.
|
|
271
|
-
- `-p, --max-pages <number>`: Maximum pages to scrape (default:
|
|
292
|
+
- `-p, --max-pages <number>`: Maximum pages to scrape (default: 1000).
|
|
272
293
|
- `-d, --max-depth <number>`: Maximum navigation depth (default: 3).
|
|
273
294
|
- `-c, --max-concurrency <number>`: Maximum concurrent requests (default: 3).
|
|
274
295
|
- `--ignore-errors`: Ignore errors during scraping (default: true).
|
|
@@ -471,13 +492,14 @@ This project uses [semantic-release](https://github.com/semantic-release/semanti
|
|
|
471
492
|
**How it works:**
|
|
472
493
|
|
|
473
494
|
1. **Commit Messages:** All commits merged into the `main` branch **must** follow the Conventional Commits specification.
|
|
474
|
-
2. **
|
|
495
|
+
2. **Manual Trigger:** The "Release" GitHub Actions workflow can be triggered manually from the Actions tab when you're ready to create a new release.
|
|
475
496
|
3. **`semantic-release` Actions:** Determines version, updates `CHANGELOG.md` & `package.json`, commits, tags, publishes to npm, and creates a GitHub Release.
|
|
476
497
|
|
|
477
498
|
**What you need to do:**
|
|
478
499
|
|
|
479
500
|
- Use Conventional Commits.
|
|
480
|
-
- Merge to `main`.
|
|
501
|
+
- Merge changes to `main`.
|
|
502
|
+
- Trigger a release manually when ready from the Actions tab in GitHub.
|
|
481
503
|
|
|
482
504
|
**Automation handles:** Changelog, version bumps, tags, npm publish, GitHub releases.
|
|
483
505
|
|