Skip to content

Commit 5711871

Browse files
committed
refactor(skills): enhance descriptions and improve clarity in usage documentation
1 parent 73d728c commit 5711871

2 files changed

Lines changed: 41 additions & 61 deletions

File tree

skills/docshark/SKILL.md

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,44 @@
11
---
22
name: docshark
3-
description: Use when answering framework, library, SDK, or API documentation questions with DocShark MCP tools. Use for indexed-doc lookup, full-page retrieval, and library lifecycle operations.
3+
description: Use when answering framework, library, SDK, or API documentation questions with DocShark MCP tools, especially for indexed-doc search, full-page retrieval, and library lifecycle tasks.
44
---
55

66
# DocShark MCP Usage
77

8-
## Overview
8+
Use DocShark in this exact order:
99

10-
Use DocShark as a tool-first docs workflow. Keep answers grounded in tool output, not model memory.
10+
1. `list_libraries` if coverage is unknown.
11+
2. `search_docs` for primary lookup (natural language queries).
12+
3. `get_doc_page` only when snippet context is not enough.
13+
4. `manage_library` for lifecycle operations.
1114

12-
## Use These Tools
15+
## Current Tool Contract
1316

14-
- `list_libraries` - discover what is indexed.
15-
- `search_docs` - primary natural-language search.
16-
- `search_docs_batch` - multiple related queries in one call.
17-
- `get_doc_page` - fetch full markdown for one page.
18-
- `manage_library` - lifecycle actions: `add`, `rename`, `refresh`, `remove`, `info`.
17+
- Read/search:
18+
- `list_libraries`
19+
- `search_docs`
20+
- `search_docs_batch`
21+
- `get_doc_page`
22+
- Lifecycle:
23+
- `manage_library` with `action` in `add | rename | refresh | remove | info`
1924

20-
Important: do not call `add_library`, `refresh_library`, or `remove_library`; those are not current tool names.
25+
Do not call deprecated/nonexistent tool names such as `add_library`, `refresh_library`, or `remove_library`.
2126

22-
## Default Flow
27+
## manage_library Required Inputs
2328

24-
1. Call `list_libraries` if library coverage is unknown.
25-
2. Call `search_docs` with a natural-language query.
26-
3. Call `get_doc_page` only when snippet context is insufficient.
27-
4. If docs are missing or stale, call `manage_library` with the correct `action`.
29+
- `add`: `url` (optional `name`, `version`, `max_depth`)
30+
- `refresh`: `library`
31+
- `remove`: `library`
32+
- `info`: `library`
33+
- `rename`: `current_name`, `new_name`
2834

29-
## manage_library Quick Guide
35+
## Query Style
3036

31-
- Add docs:
32-
- `action: "add"`
33-
- required: `url`
34-
- optional: `name`, `version`, `max_depth`
35-
- Refresh docs:
36-
- `action: "refresh"`
37-
- required: `library`
38-
- Remove docs:
39-
- `action: "remove"`
40-
- required: `library`
41-
- Inspect one library:
42-
- `action: "info"`
43-
- required: `library`
44-
- Rename library:
45-
- `action: "rename"`
46-
- required: `current_name`, `new_name`
37+
- Use natural language: `SvelteKit form actions redirect after submit`
38+
- Avoid keyword fragments: `sveltekit form redirect`
4739

48-
## Query Patterns
40+
## Output Rules
4941

50-
Use natural language, not keyword fragments.
51-
52-
- Good: `SvelteKit form actions redirect after submit`
53-
- Good: `TanStack Query cache invalidation guidance`
54-
- Weak: `sveltekit form redirect`
55-
56-
## Response Rules
57-
58-
- Cite what DocShark returned.
59-
- If no results, say so and refine query or library scope.
60-
- If library is missing, state that and use `manage_library` `action: "add"`.
42+
- Ground answers in tool output.
43+
- If nothing is found, say so and refine query/filter.
44+
- If a library is missing, use `manage_library` with `action: "add"`.

skills/using-docshark/SKILL.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
---
22
name: using-docshark
3-
description: Use when installing, running, and troubleshooting DocShark as an MCP server, or when configuring clients to connect through STDIO or HTTP MCP endpoints.
3+
description: Use when installing, running, and troubleshooting DocShark as an MCP server, including client setup for STDIO mode and endpoint checks for HTTP mode.
44
---
55

66
# Operating DocShark
77

8-
## Overview
9-
10-
This skill covers accurate runtime setup and troubleshooting for the current DocShark codebase.
11-
128
## Start Modes
139

14-
### STDIO mode (for MCP clients)
10+
### STDIO mode (MCP clients)
1511

1612
```bash
1713
docshark --stdio
@@ -23,17 +19,17 @@ or
2319
npx docshark --stdio
2420
```
2521

26-
Use this when a client launches DocShark as a subprocess MCP server.
22+
Use STDIO when a client launches DocShark as a subprocess MCP server.
2723

2824
### HTTP mode
2925

3026
```bash
3127
docshark
3228
```
3329

34-
Default HTTP port is `6380` unless `--port` is provided.
30+
Default HTTP port is `6380` (override with `--port`).
3531

36-
When running in HTTP mode, key endpoints are:
32+
HTTP endpoints:
3733

3834
- `/mcp`
3935
- `/sse`
@@ -47,7 +43,7 @@ When running in HTTP mode, key endpoints are:
4743
- CLI: `--data-dir <path>`
4844
- Env: `DOCSHARK_DATA_DIR`
4945

50-
## Reliable CLI Operations
46+
## Core CLI Operations
5147

5248
- `docshark add <url>`
5349
- `docshark list`
@@ -60,13 +56,13 @@ When running in HTTP mode, key endpoints are:
6056
## Troubleshooting
6157

6258
- No search results:
63-
1. Run `docshark list` to verify library exists.
64-
2. Run `docshark refresh <library>` for stale index.
65-
3. Re-run search with a more explicit natural-language query.
59+
1. Verify with `docshark list`.
60+
2. Refresh with `docshark refresh <library>`.
61+
3. Re-run with a clearer natural-language query.
6662
- Client cannot connect in STDIO mode:
67-
1. Verify client command uses `docshark --stdio` (or `npx docshark --stdio`).
68-
2. Check that `docshark` is on PATH if not using `npx`.
63+
1. Verify startup command is `docshark --stdio` or `npx docshark --stdio`.
64+
2. Ensure `docshark` is on PATH if not using `npx`.
6965
- HTTP mode not reachable:
70-
1. Verify process is running.
66+
1. Confirm process is running.
7167
2. Check `/api/health`.
72-
3. Confirm selected `--port` is not occupied.
68+
3. Confirm chosen `--port` is available.

0 commit comments

Comments
 (0)