@afterxleep/doc-bot 1.0.1 → 1.0.2
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 +14 -12
- package/bin/doc-bot.js +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@afterxleep/doc-bot)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
|
-
A generic MCP (Model Context Protocol) server that provides intelligent documentation access for any project. Works with
|
|
6
|
+
A generic MCP (Model Context Protocol) server that provides intelligent documentation access for any project. Works with any MCP-compatible AI tools and IDEs.
|
|
7
7
|
|
|
8
8
|
## What is doc-bot?
|
|
9
9
|
|
|
@@ -16,23 +16,25 @@ doc-bot is an intelligent documentation server that:
|
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
1. **Create your documentation folder** in your project root (see organization section below)
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
2. **Add doc-bot to your MCP-compatible AI tool configuration**:
|
|
22
|
+
|
|
23
|
+
**For Claude Code** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
|
|
22
24
|
```json
|
|
23
25
|
{
|
|
24
26
|
"mcpServers": {
|
|
25
27
|
"docs": {
|
|
26
28
|
"command": "npx",
|
|
27
|
-
"args": ["@afterxleep/doc-bot"]
|
|
29
|
+
"args": ["@afterxleep/doc-bot", "--docs", "./doc-bot"]
|
|
28
30
|
}
|
|
29
31
|
}
|
|
30
32
|
}
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
**For Cursor or other MCP tools**: Add similar configuration pointing to your documentation folder
|
|
34
36
|
|
|
35
|
-
3. **
|
|
37
|
+
3. **Restart your AI tool**
|
|
36
38
|
|
|
37
39
|
## How to organize your documentation
|
|
38
40
|
|
|
@@ -53,9 +55,9 @@ your-project/
|
|
|
53
55
|
└── package.json
|
|
54
56
|
```
|
|
55
57
|
|
|
56
|
-
**Note:** You can use
|
|
57
|
-
```
|
|
58
|
-
|
|
58
|
+
**Note:** You can use any folder name - just specify it in your MCP configuration:
|
|
59
|
+
```json
|
|
60
|
+
"args": ["@afterxleep/doc-bot", "--docs", "./my-custom-docs"]
|
|
59
61
|
```
|
|
60
62
|
|
|
61
63
|
### Documentation types:
|
|
@@ -137,7 +139,7 @@ The `doc-bot/manifest.json` file controls how your documentation works:
|
|
|
137
139
|
|
|
138
140
|
### Testing your setup
|
|
139
141
|
|
|
140
|
-
Ask
|
|
142
|
+
Ask your AI assistant something like "What documentation is available?" to test that doc-bot is working.
|
|
141
143
|
|
|
142
144
|
### CLI Options
|
|
143
145
|
|
|
@@ -145,9 +147,9 @@ Ask Claude something like "What documentation is available?" to test that doc-bo
|
|
|
145
147
|
doc-bot [options]
|
|
146
148
|
|
|
147
149
|
Options:
|
|
150
|
+
-d, --docs <path> Path to docs folder (required)
|
|
151
|
+
-c, --config <path> Path to manifest file (default: <docs-path>/manifest.json)
|
|
148
152
|
-p, --port <port> Port to run server on (default: 3000)
|
|
149
|
-
-d, --docs <path> Path to docs folder (default: ./doc-bot)
|
|
150
|
-
-c, --config <path> Path to manifest file (default: ./doc-bot/manifest.json)
|
|
151
153
|
-v, --verbose Enable verbose logging
|
|
152
154
|
-w, --watch Watch for file changes
|
|
153
155
|
-h, --help Show help
|
package/bin/doc-bot.js
CHANGED
|
@@ -8,10 +8,10 @@ const { DocsServer } = require('../src/index.js');
|
|
|
8
8
|
program
|
|
9
9
|
.name('doc-bot')
|
|
10
10
|
.description('Generic MCP server for intelligent documentation access')
|
|
11
|
-
.version('1.0.
|
|
11
|
+
.version('1.0.2')
|
|
12
12
|
.option('-p, --port <port>', 'Port to run server on', '3000')
|
|
13
|
-
.
|
|
14
|
-
.option('-c, --config <path>', 'Path to manifest file'
|
|
13
|
+
.requiredOption('-d, --docs <path>', 'Path to docs folder')
|
|
14
|
+
.option('-c, --config <path>', 'Path to manifest file')
|
|
15
15
|
.option('-v, --verbose', 'Enable verbose logging')
|
|
16
16
|
.option('-w, --watch', 'Watch for file changes')
|
|
17
17
|
.parse();
|
|
@@ -20,19 +20,19 @@ const options = program.opts();
|
|
|
20
20
|
|
|
21
21
|
async function main() {
|
|
22
22
|
const docsPath = path.resolve(options.docs);
|
|
23
|
-
const configPath = path.resolve(options.config);
|
|
23
|
+
const configPath = options.config ? path.resolve(options.config) : path.resolve(options.docs, 'manifest.json');
|
|
24
24
|
|
|
25
|
-
// Check if
|
|
25
|
+
// Check if documentation folder exists
|
|
26
26
|
if (!await fs.pathExists(docsPath)) {
|
|
27
27
|
console.error(`❌ Documentation folder not found: ${docsPath}`);
|
|
28
28
|
console.log('');
|
|
29
|
-
console.log('📖 To get started, create
|
|
29
|
+
console.log('📖 To get started, create your documentation folder:');
|
|
30
30
|
console.log('');
|
|
31
|
-
console.log(
|
|
32
|
-
console.log(
|
|
33
|
-
console.log(
|
|
31
|
+
console.log(` mkdir ${path.basename(docsPath)}`);
|
|
32
|
+
console.log(` echo '{"name": "My Project Documentation", "globalRules": []}' > ${path.basename(docsPath)}/manifest.json`);
|
|
33
|
+
console.log(` echo "# Getting Started" > ${path.basename(docsPath)}/README.md`);
|
|
34
34
|
console.log('');
|
|
35
|
-
console.log('Then
|
|
35
|
+
console.log('Then configure your MCP client to use this folder.');
|
|
36
36
|
process.exit(1);
|
|
37
37
|
}
|
|
38
38
|
|