@yawlabs/nol-mcp 0.1.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.
- package/README.md +35 -0
- package/dist/index.js +31122 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# @yawlabs/nol-mcp
|
|
2
|
+
|
|
3
|
+
MCP server for **nol** -- query your team's knowledge base (search, cited Q&A,
|
|
4
|
+
spaces, pages) from AI assistants. Read-only. Proprietary (`UNLICENSED`), part of
|
|
5
|
+
the nol product.
|
|
6
|
+
|
|
7
|
+
It is a thin client over the nol core API: it never talks to Postgres or
|
|
8
|
+
re-implements retrieval. Authenticates with a workspace-scoped API key bound to a
|
|
9
|
+
principal, so the server enforces ACLs.
|
|
10
|
+
|
|
11
|
+
## Configure
|
|
12
|
+
|
|
13
|
+
| Env | Default | Purpose |
|
|
14
|
+
|-----|---------|---------|
|
|
15
|
+
| `NOL_API_URL` | `http://localhost:3001` | nol core API base URL |
|
|
16
|
+
| `NOL_API_KEY` | (required) | workspace-scoped API key bound to a principal |
|
|
17
|
+
|
|
18
|
+
## Tools
|
|
19
|
+
|
|
20
|
+
| Tool | Access | Purpose |
|
|
21
|
+
|------|--------|---------|
|
|
22
|
+
| `nol_search` | read | semantic + lexical search |
|
|
23
|
+
| `nol_ask` | read | cited RAG answer |
|
|
24
|
+
| `nol_list_spaces` | read | list spaces with page counts |
|
|
25
|
+
| `nol_get_space_tree` | read | flat page list for a space |
|
|
26
|
+
| `nol_get_page` | read | fetch a page's Markdown + metadata |
|
|
27
|
+
| `nol_get_page_revisions` | read | a page's revision history |
|
|
28
|
+
|
|
29
|
+
## Develop
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm install
|
|
33
|
+
npm run build # tsc + esbuild single-file bundle -> dist/index.js
|
|
34
|
+
npm test
|
|
35
|
+
```
|