norgolith-mcp 1.1.0

MCP server for Norgolith documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# Norgolith MCP Server

MCP (Model Context Protocol) server for Norgolith documentation. Lets AI assistants browse, read, and search Norgolith docs directly.

## Installation

Build from source:

```bash
cargo build --release --manifest-path norgolith-mcp/Cargo.toml
```

The binary is at `target/release/norgolith-mcp`.

## Configuration

Add to your MCP client config (e.g., `opencode.json`):

```json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "norgolith": {
      "type": "local",
      "command": "norgolith-mcp",
      "enabled": true
    }
  }
}
```

Make sure `norgolith-mcp` is in your `PATH`, or use the full path to the binary.

## Resources

Each documentation page is available as a resource with URI `norgolith://{path}` and MIME type `text/x-norg`.

| URI | Description |
| --- | ----------- |
| `norgolith://docs/commands` | CLI commands reference |
| `norgolith://docs/configuration` | Site configuration reference |
| `norgolith://docs/content-schemas` | Content schema validation |
| `norgolith://docs/contributing` | Contributing guide |
| `norgolith://docs/getting-started` | Quick start guide |
| `norgolith://docs/index` | Documentation index |
| `norgolith://docs/installation` | Installation guide |
| `norgolith://docs/plugins` | Plugin development guide |
| `norgolith://docs/templating` | Templating reference |
| `norgolith://docs/templating-migration` | Tera v2 migration guide |
| `norgolith://docs/theming` | Theming guide |
| `norgolith://index` | Site landing page |

Source code resources (MIME type `text/x-rust`):

| URI | Description |
| --- | ----------- |
| `norgolith://src/sdk/lib.rs` | Plugin SDK API |
| `norgolith://src/core/plugin/mod.rs` | Plugin loader core |
| `norgolith://src/core/plugin/ffi.rs` | C ABI bridge |
| `norgolith://src/core/plugin/manifest.rs` | Plugin manifest parsing |
| `norgolith://src/core/plugin/sandbox.rs` | Landlock sandboxing |
| `norgolith://src/core/shared/render.rs` | Tera context variables |
| `norgolith://src/core/shared/metadata.rs` | Page metadata structure |
| `norgolith://src/core/tera/mod.rs` | Tera functions, filters, and tests |

## Tools

| Tool | Description |
|------|-------------|
| `search_docs(query)` | Search all documentation for a query string |
| `read_source(path)` | Read a source file from the repo (monorepo only) |

## Prompts

Examples you can ask the AI with this MCP server enabled:

**Plugin development:**
- "How do I write a Norgolith plugin?"
- "How does the plugin manifest work?"
- "What hooks are available and when do they run?"
- "Show me the plugin SDK source code"
- "How does the FFI bridge work?"

**Theme development:**
- "How do I create a Norgolith theme?"
- "What Tera variables are available in templates?"
- "Show me all registered Tera filters and functions"
- "How does `generate_toc` work?"
- "What page metadata fields can I use in my theme?"

**General:**
- "What commands does lith have?"
- "How do I configure content schemas?"
- "Search docs for draft handling"
- "How does the build pipeline work?"

## See Also

- [Norgolith documentation](https://norgolith.dev/docs)
- [Norgolith repository](https://github.com/norgolith/core)