@doquflow/server 0.4.0 → 0.4.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 +49 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# @doquflow/server
|
|
2
2
|
|
|
3
|
-
MCP server that lets AI agents read any codebase and
|
|
3
|
+
MCP server that lets AI agents read any codebase and build a persistent, incrementally-maintained knowledge base using the **LLM Wiki pattern**. 15 tools. Zero AI inside — the agent does all the thinking.
|
|
4
4
|
|
|
5
5
|
```
|
|
6
|
-
AI Agent (Claude
|
|
6
|
+
AI Agent (Claude, Copilot, Cursor)
|
|
7
7
|
│ calls MCP tools
|
|
8
|
-
@doquflow/server ← reads files,
|
|
8
|
+
@doquflow/server ← reads files, builds wiki, answers questions
|
|
9
9
|
│ filesystem only
|
|
10
10
|
Any project on disk ← any language, any structure
|
|
11
11
|
```
|
|
@@ -16,29 +16,61 @@ Any project on disk ← any language, any structure
|
|
|
16
16
|
npx @doquflow/cli init
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
The CLI registers this server automatically
|
|
19
|
+
The CLI registers this server automatically. You do not need to install `@doquflow/server` directly.
|
|
20
20
|
|
|
21
|
-
## Tools
|
|
21
|
+
## Tools (15 total)
|
|
22
|
+
|
|
23
|
+
### Code Extraction
|
|
22
24
|
|
|
23
25
|
| Tool | Input | Output |
|
|
24
26
|
|------|-------|--------|
|
|
25
|
-
| `read_module` | `{ path }` |
|
|
26
|
-
| `list_modules` | `{ path, extensions? }` | All modules in a directory tree |
|
|
27
|
-
| `write_spec` | `{ project_path, filename, content }` | Writes
|
|
28
|
-
| `read_specs` | `{ project_path, module_name? }` | Reads existing specs
|
|
27
|
+
| `read_module` | `{ path }` | Language, classes, functions, dependencies, DB tables, endpoints, config refs, raw content |
|
|
28
|
+
| `list_modules` | `{ path, extensions? }` | All modules in a directory tree (bulk extraction, no raw content) |
|
|
29
|
+
| `write_spec` | `{ project_path, filename, content }` | Writes markdown spec to `.docuflow/specs/` |
|
|
30
|
+
| `read_specs` | `{ project_path, module_name? }` | Reads existing specs; includes `stale: boolean` per spec |
|
|
29
31
|
|
|
30
|
-
|
|
32
|
+
### Wiki Pipeline
|
|
33
|
+
|
|
34
|
+
| Tool | What it does |
|
|
35
|
+
|------|-------------|
|
|
36
|
+
| `ingest_source` | Parse source doc → extract entities/concepts → create wiki pages with context |
|
|
37
|
+
| `update_index` | Regenerate `index.md` and append to `log.md` |
|
|
38
|
+
| `list_wiki` | List wiki pages by category; includes `stale: boolean` per page and `stale_pages` count |
|
|
39
|
+
| `wiki_search` | BM25-inspired relevance search across all wiki pages |
|
|
40
|
+
| `query_wiki` | Main interface: search + synthesize answer from wiki |
|
|
41
|
+
| `answer_synthesis` | Build structured markdown answer from selected pages |
|
|
42
|
+
| `save_answer_as_page` | Save synthesised answer back to wiki |
|
|
43
|
+
|
|
44
|
+
### Health & Guidance
|
|
45
|
+
|
|
46
|
+
| Tool | What it does |
|
|
47
|
+
|------|-------------|
|
|
48
|
+
| `lint_wiki` | Health checks: orphan pages, stale content, broken links, metadata gaps, contradictions. Returns 0-100 health score. |
|
|
49
|
+
| `get_schema_guidance` | Detect domain → recommend missing wiki pages |
|
|
50
|
+
| `preview_generation` | Show what a tool will do before running (reads real wiki state) |
|
|
51
|
+
|
|
52
|
+
### Dependency Analysis
|
|
31
53
|
|
|
32
|
-
|
|
54
|
+
| Tool | What it does |
|
|
55
|
+
|------|-------------|
|
|
56
|
+
| `generate_dependency_graph` | Build import/shared-table/shared-endpoint graph. Returns `nodes`, `edges`, `most_connected` top 10 (highest-risk files). |
|
|
57
|
+
|
|
58
|
+
## Languages supported
|
|
59
|
+
|
|
60
|
+
TypeScript, JavaScript, Python, Go (structs, funcs, gin/gorilla routes, GORM), Ruby/Rails (classes, ActiveRecord, Rails routes), Rust, Java, C#, PHP, Kotlin, Swift, SQL, Shell, YAML, JSON, and more.
|
|
61
|
+
|
|
62
|
+
Unknown file types return full raw content — never fails on unfamiliar files.
|
|
63
|
+
|
|
64
|
+
## Extraction engine
|
|
33
65
|
|
|
34
66
|
| Field | Detected from |
|
|
35
67
|
|-------|--------------|
|
|
36
|
-
| `classes` | `class`, `interface`, `struct`, `enum`, `record` |
|
|
37
|
-
| `functions` | Keyword-prefixed declarations
|
|
38
|
-
| `dependencies` | `import`, `require()`,
|
|
39
|
-
| `db_tables` | SQL `FROM/JOIN/INTO`, EF `DbSet<T>`, `
|
|
40
|
-
| `endpoints` | .NET attributes,
|
|
41
|
-
| `config_refs` | `
|
|
68
|
+
| `classes` | `class`, `interface`, `struct`, `enum`, `record`, Go `type … struct/interface`, Ruby `module` |
|
|
69
|
+
| `functions` | Keyword-prefixed declarations, arrow functions, Go `func`, Ruby `def` |
|
|
70
|
+
| `dependencies` | `import`, `require()`, Go import blocks, Ruby require |
|
|
71
|
+
| `db_tables` | SQL `FROM/JOIN/INTO`, EF `DbSet<T>`, GORM `db.Table()`, ActiveRecord associations |
|
|
72
|
+
| `endpoints` | .NET attributes, Express/NestJS, gin/gorilla/chi routes, Rails route helpers |
|
|
73
|
+
| `config_refs` | `process.env`, `os.Getenv`, `ENV['KEY']`, `IConfiguration`, `appsettings` |
|
|
42
74
|
|
|
43
75
|
## Requirements
|
|
44
76
|
|