@hiveforge/hivemind-mcp 2.4.0 → 2.6.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.
Files changed (53) hide show
  1. package/README.md +70 -8
  2. package/dist/cli.js +938 -77
  3. package/dist/cli.js.map +1 -1
  4. package/dist/config/schema.d.ts +125 -0
  5. package/dist/config/schema.d.ts.map +1 -0
  6. package/dist/config/schema.js +79 -0
  7. package/dist/config/schema.js.map +1 -0
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +35 -2
  10. package/dist/index.js.map +1 -1
  11. package/dist/search/engine.d.ts.map +1 -1
  12. package/dist/search/engine.js +52 -21
  13. package/dist/search/engine.js.map +1 -1
  14. package/dist/server.d.ts.map +1 -1
  15. package/dist/server.js +11 -0
  16. package/dist/server.js.map +1 -1
  17. package/dist/templates/builtin/people-management.d.ts.map +1 -1
  18. package/dist/templates/builtin/people-management.js +10 -0
  19. package/dist/templates/builtin/people-management.js.map +1 -1
  20. package/dist/templates/builtin/research.d.ts.map +1 -1
  21. package/dist/templates/builtin/research.js +10 -0
  22. package/dist/templates/builtin/research.js.map +1 -1
  23. package/dist/templates/builtin/worldbuilding.d.ts.map +1 -1
  24. package/dist/templates/builtin/worldbuilding.js +10 -0
  25. package/dist/templates/builtin/worldbuilding.js.map +1 -1
  26. package/dist/templates/community/architecture.d.ts +19 -0
  27. package/dist/templates/community/architecture.d.ts.map +1 -0
  28. package/dist/templates/community/architecture.js +296 -0
  29. package/dist/templates/community/architecture.js.map +1 -0
  30. package/dist/templates/community/index.d.ts +37 -0
  31. package/dist/templates/community/index.d.ts.map +1 -0
  32. package/dist/templates/community/index.js +45 -0
  33. package/dist/templates/community/index.js.map +1 -0
  34. package/dist/templates/community/ux-research.d.ts +21 -0
  35. package/dist/templates/community/ux-research.d.ts.map +1 -0
  36. package/dist/templates/community/ux-research.js +347 -0
  37. package/dist/templates/community/ux-research.js.map +1 -0
  38. package/dist/templates/loader.d.ts +62 -7
  39. package/dist/templates/loader.d.ts.map +1 -1
  40. package/dist/templates/loader.js +132 -11
  41. package/dist/templates/loader.js.map +1 -1
  42. package/dist/templates/types.d.ts +29 -0
  43. package/dist/templates/types.d.ts.map +1 -1
  44. package/dist/templates/validator.d.ts +56 -0
  45. package/dist/templates/validator.d.ts.map +1 -1
  46. package/dist/templates/validator.js +32 -0
  47. package/dist/templates/validator.js.map +1 -1
  48. package/dist/templates/version.d.ts +63 -0
  49. package/dist/templates/version.d.ts.map +1 -0
  50. package/dist/templates/version.js +119 -0
  51. package/dist/templates/version.js.map +1 -0
  52. package/dist/types/index.d.ts +12 -12
  53. package/package.json +1 -1
package/README.md CHANGED
@@ -14,6 +14,8 @@
14
14
 
15
15
  A domain-agnostic MCP (Model Context Protocol) server for Obsidian vaults that provides AI tools with consistent, structured context from your knowledge base.
16
16
 
17
+ **The AI Memory Firewall**: Hivemind's core value isn't just better answers — it's *preventing AI from inventing context*. Your knowledge graph becomes a truth anchor that keeps AI grounded in facts you control.
18
+
17
19
  ## What is Hivemind?
18
20
 
19
21
  Hivemind bridges your Obsidian vault and AI tools (Claude, ComfyUI, etc.) via the Model Context Protocol. With pluggable templates, it supports multiple domains out of the box:
@@ -21,20 +23,36 @@ Hivemind bridges your Obsidian vault and AI tools (Claude, ComfyUI, etc.) via th
21
23
  - **Worldbuilding** — Characters, Locations, Events, Factions, Lore, Assets
22
24
  - **Research** — Papers, Citations, Concepts, Notes
23
25
  - **People Management** — People, Goals, Teams, 1:1 Meetings
26
+ - **Software Architecture** — Systems, Components, ADRs, Constraints *(community)*
27
+ - **UX Research** — Interviews, Insights, Hypotheses, Personas *(community)*
24
28
 
25
29
  Or define your own custom entity types via `config.json` — no code required.
26
30
 
27
31
  ## Features
28
32
 
29
- - **Pluggable Templates**: Built-in templates for worldbuilding, research, and people management — or define your own
33
+ - **Pluggable Templates**: Built-in templates for worldbuilding, research, people management, and software architecture — or define your own
30
34
  - **HybridRAG Search**: Combines vector, graph, and keyword search for accurate context retrieval
31
35
  - **Obsidian Native**: Works with standard markdown, YAML frontmatter, and wikilinks
32
36
  - **Custom Relationships**: Define relationship types per template with bidirectionality and validation
33
37
  - **Asset Provenance**: Track AI-generated images and their generation settings
34
- - **Local-First**: Your data stays on your machine, with optional cloud deployment
35
- - **Canon Management**: Draft → Pending → Canon approval workflow
38
+ - **Local-First**: Your data stays on your machine critical for sensitive domains like people management and architecture decisions
39
+ - **Canon Management**: Draft → Pending → Canon approval workflow with consistency validation
36
40
  - **High Performance**: <300ms query latency, supports 1000+ note vaults
37
41
 
42
+ ### Canon Workflow: Not Just for Fiction
43
+
44
+ The canon workflow applies far beyond worldbuilding:
45
+
46
+ | Domain | What Gets Canon Status |
47
+ |--------|----------------------|
48
+ | **Worldbuilding** | Approved lore, character facts, timeline events |
49
+ | **Architecture** | Accepted ADRs, design decisions, constraints |
50
+ | **Brand** | Voice guidelines, approved messaging, visual identity |
51
+ | **Security** | Approved policies, access controls, compliance rules |
52
+ | **People Management** | Finalized goals, approved team structures |
53
+
54
+ AI that references non-canon content gets flagged. AI that violates canon constraints gets corrected. This is **governance without meetings**.
55
+
38
56
  ## Quick Start
39
57
 
40
58
  ### Installation
@@ -132,13 +150,15 @@ If you prefer to configure manually, create a `config.json`:
132
150
 
133
151
  ### Choosing a Template
134
152
 
135
- Set `activeTemplate` to one of the built-in templates:
153
+ Set `activeTemplate` to one of the built-in or community templates:
136
154
 
137
155
  | Template | Use Case | Entity Types |
138
156
  |----------|----------|--------------|
139
157
  | `worldbuilding` | Fiction writers, game masters | Characters, Locations, Events, Factions, Lore, Assets, References |
140
158
  | `research` | Academics, knowledge workers | Papers, Citations, Concepts, Notes |
141
159
  | `people-management` | Managers, team leads | People, Goals, Teams, 1:1 Meetings |
160
+ | `software-architecture` | Engineers, architects | Systems, Components, Decisions (ADRs), Constraints, Interfaces |
161
+ | `ux-research` | UX researchers, product teams | Interviews, Insights, Hypotheses, Personas, Experiments |
142
162
 
143
163
  ### Custom Templates
144
164
 
@@ -177,6 +197,35 @@ Define custom entity types directly in your `config.json`:
177
197
 
178
198
  See [samples/](samples/) for complete example vaults for each template.
179
199
 
200
+ ### CLI Template Tools
201
+
202
+ Create, manage, and validate templates using the command line:
203
+
204
+ ```bash
205
+ # List available templates (built-in + community)
206
+ npx @hiveforge/hivemind-mcp list-templates
207
+
208
+ # Add a template from the registry, URL, or local file
209
+ npx @hiveforge/hivemind-mcp add-template software-architecture
210
+ npx @hiveforge/hivemind-mcp add-template https://example.com/template.json
211
+ npx @hiveforge/hivemind-mcp add-template ./my-template.json
212
+
213
+ # Interactive template creation wizard
214
+ npx @hiveforge/hivemind-mcp create-template
215
+
216
+ # Validate a template file
217
+ npx @hiveforge/hivemind-mcp validate-template template.json
218
+
219
+ # Check template compatibility with your Hivemind version
220
+ npx @hiveforge/hivemind-mcp check-compatibility
221
+ npx @hiveforge/hivemind-mcp check-compatibility software-architecture
222
+
223
+ # Generate template catalog JSON (for documentation sites)
224
+ npx @hiveforge/hivemind-mcp generate-catalog
225
+ ```
226
+
227
+ Want to contribute a template? See [CONTRIBUTING_TEMPLATES.md](CONTRIBUTING_TEMPLATES.md).
228
+
180
229
  ## Architecture
181
230
 
182
231
  ```
@@ -198,7 +247,16 @@ Obsidian Vault → File Watcher → Markdown Parser → Knowledge Graph
198
247
 
199
248
  ## Development Status
200
249
 
201
- **Current**: v2.0 Template System Complete ✅
250
+ **Current**: v2.1 Community Templates Complete ✅
251
+
252
+ ### v2.1 — Community Templates (Complete)
253
+
254
+ - [x] CLI tools: `create-template`, `validate-template`, `add-template`, `list-templates`
255
+ - [x] Community templates: software-architecture, ux-research
256
+ - [x] Enhanced metadata: category, tags, author, repository, license
257
+ - [x] Template catalog generation for docs sites
258
+ - [x] Version compatibility checking with `minHivemindVersion`
259
+ - [x] Template contribution guide
202
260
 
203
261
  ### v2.0 — Template System (Complete)
204
262
 
@@ -226,7 +284,7 @@ Hivemind is now domain-agnostic with pluggable templates:
226
284
 
227
285
  - [ ] Obsidian community plugin submission
228
286
  - [ ] Timeline queries with date range filtering
229
- - [ ] First-run setup wizard
287
+ - [ ] Web-based template builder
230
288
 
231
289
  ## MCP Tools
232
290
 
@@ -239,13 +297,15 @@ Tools are automatically generated for each entity type defined in the active tem
239
297
  | `query_<type>` | Get entity by ID/name with relationships and content |
240
298
  | `list_<type>` | List all entities of type with optional filters |
241
299
 
242
- **Built-in template tools:**
300
+ **Built-in and community template tools:**
243
301
 
244
302
  | Template | Generated Tools |
245
303
  |----------|-----------------|
246
304
  | `worldbuilding` | `query_character`, `query_location`, `query_event`, `query_faction`, `query_lore`, `query_asset`, `query_reference` + list variants |
247
305
  | `research` | `query_paper`, `query_citation`, `query_concept`, `query_note` + list variants |
248
306
  | `people-management` | `query_person`, `query_goal`, `query_team`, `query_one_on_one` + list variants |
307
+ | `software-architecture` | `query_system`, `query_component`, `query_decision`, `query_constraint`, `query_interface` + list variants |
308
+ | `ux-research` | `query_interview`, `query_insight`, `query_hypothesis`, `query_persona`, `query_experiment` + list variants |
249
309
 
250
310
  ### Search
251
311
  | Tool | Description |
@@ -284,10 +344,12 @@ Tools are automatically generated for each entity type defined in the active tem
284
344
 
285
345
  - [Setup Guide](docs/SETUP_GUIDE.md) — Getting started with Hivemind
286
346
  - [Vault Migration Guide](docs/VAULT_MIGRATION_GUIDE.md) — Migrating existing vaults
347
+ - [Canon Workflow for Enterprise](docs/CANON_WORKFLOW_ENTERPRISE.md) — Using canon workflow for ADRs, research, and more
287
348
  - [MCP Compatibility](docs/MCP_COMPATIBILITY.md) — Supported AI clients
288
349
  - [ComfyUI Integration](docs/COMFYUI_INTEGRATION.md) — AI image generation
289
350
  - [Obsidian Plugin Workflow](docs/OBSIDIAN_PLUGIN_WORKFLOW.md) — Plugin development
290
- - [Sample Vaults](samples/README.md) — Example vaults for each built-in template
351
+ - [Sample Vaults](samples/README.md) — Example vaults for each template
352
+ - [Contributing Templates](CONTRIBUTING_TEMPLATES.md) — How to create and contribute templates
291
353
 
292
354
  ## License
293
355