@tesseron/docs-mcp 0.2.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/LICENSE +114 -0
- package/README.md +95 -0
- package/dist/docs-index.json +1 -0
- package/dist/index.cjs +232 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +68 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.js +222 -0
- package/dist/index.js.map +1 -0
- package/dist/tesseron-docs-mcp.cjs +23314 -0
- package/package.json +71 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
Business Source License 1.1
|
|
2
|
+
|
|
3
|
+
License text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.
|
|
4
|
+
"Business Source License" is a trademark of MariaDB Corporation Ab.
|
|
5
|
+
|
|
6
|
+
-----------------------------------------------------------------------------
|
|
7
|
+
|
|
8
|
+
Parameters
|
|
9
|
+
|
|
10
|
+
Licensor: Kenny Vaneetvelde
|
|
11
|
+
|
|
12
|
+
Licensed Work: Tesseron
|
|
13
|
+
The Licensed Work is (c) 2026 Kenny Vaneetvelde.
|
|
14
|
+
|
|
15
|
+
Additional Use Grant: You may make production use of the Licensed Work,
|
|
16
|
+
provided your use does not include offering the
|
|
17
|
+
Licensed Work, or a substantial portion of its
|
|
18
|
+
functionality, to third parties as a hosted or
|
|
19
|
+
managed service.
|
|
20
|
+
|
|
21
|
+
For clarity, permitted uses include (but are not
|
|
22
|
+
limited to): embedding the Licensed Work in your
|
|
23
|
+
own applications (commercial or otherwise),
|
|
24
|
+
internal use within your organization, consulting
|
|
25
|
+
engagements that integrate the Licensed Work into
|
|
26
|
+
client applications, redistributing modified or
|
|
27
|
+
unmodified copies of the Licensed Work, and running
|
|
28
|
+
the gateway locally on end-user machines as part
|
|
29
|
+
of the user's own tooling.
|
|
30
|
+
|
|
31
|
+
Change Date: Four years from the date the Licensed Work is
|
|
32
|
+
published. For each release of the Licensed Work,
|
|
33
|
+
the Change Date is four years from the publication
|
|
34
|
+
date of that release.
|
|
35
|
+
|
|
36
|
+
Change License: Apache License, Version 2.0
|
|
37
|
+
|
|
38
|
+
-----------------------------------------------------------------------------
|
|
39
|
+
|
|
40
|
+
Terms
|
|
41
|
+
|
|
42
|
+
The Licensor hereby grants you the right to copy, modify, create derivative
|
|
43
|
+
works, redistribute, and make non-production use of the Licensed Work. The
|
|
44
|
+
Licensor may make an Additional Use Grant, above, permitting limited
|
|
45
|
+
production use.
|
|
46
|
+
|
|
47
|
+
Effective on the Change Date, or the fourth anniversary of the first
|
|
48
|
+
publicly available distribution of a specific version of the Licensed Work
|
|
49
|
+
under this License, whichever comes first, the Licensor hereby grants you
|
|
50
|
+
rights under the terms of the Change License, and the rights granted in the
|
|
51
|
+
paragraph above terminate.
|
|
52
|
+
|
|
53
|
+
If your use of the Licensed Work does not comply with the requirements
|
|
54
|
+
currently in effect as described in this License, you must purchase a
|
|
55
|
+
commercial license from the Licensor, its affiliated entities, or authorized
|
|
56
|
+
resellers, or you must refrain from using the Licensed Work.
|
|
57
|
+
|
|
58
|
+
All copies of the original and modified Licensed Work, and derivative works
|
|
59
|
+
of the Licensed Work, are subject to this License. This License applies
|
|
60
|
+
separately for each version of the Licensed Work and the Change Date may
|
|
61
|
+
vary for each version of the Licensed Work released by Licensor.
|
|
62
|
+
|
|
63
|
+
You must conspicuously display this License on each original or modified
|
|
64
|
+
copy of the Licensed Work. If you receive the Licensed Work in original or
|
|
65
|
+
modified form from a third party, the terms and conditions set forth in
|
|
66
|
+
this License apply to your use of that work.
|
|
67
|
+
|
|
68
|
+
Any use of the Licensed Work in violation of this License will automatically
|
|
69
|
+
terminate your rights under this License for the current and all other
|
|
70
|
+
versions of the Licensed Work.
|
|
71
|
+
|
|
72
|
+
This License does not grant you any right in any trademark or logo of
|
|
73
|
+
Licensor or its affiliates (provided that you may use a trademark or logo of
|
|
74
|
+
Licensor as expressly required by this License).
|
|
75
|
+
|
|
76
|
+
TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
|
|
77
|
+
AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
|
|
78
|
+
EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
|
|
79
|
+
MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
80
|
+
|
|
81
|
+
MariaDB hereby grants you permission to use this License's text to license
|
|
82
|
+
your works, and to refer to it using the trademark "Business Source License",
|
|
83
|
+
as long as you comply with the Covenants of Licensor below.
|
|
84
|
+
|
|
85
|
+
-----------------------------------------------------------------------------
|
|
86
|
+
|
|
87
|
+
Covenants of Licensor
|
|
88
|
+
|
|
89
|
+
In consideration of the right to use this License's text and the "Business
|
|
90
|
+
Source License" name and trademark, Licensor covenants to MariaDB, and to
|
|
91
|
+
all other recipients of the licensed work to be provided by Licensor:
|
|
92
|
+
|
|
93
|
+
1. To specify as the Change License the GPL Version 2.0 or any later version,
|
|
94
|
+
or a license that is compatible with GPL Version 2.0 or a later version,
|
|
95
|
+
where "compatible" means that software provided under the Change License
|
|
96
|
+
can be included in a program with software provided under GPL Version 2.0
|
|
97
|
+
or a later version. Licensor may specify additional Change Licenses
|
|
98
|
+
without limitation.
|
|
99
|
+
|
|
100
|
+
2. To either: (a) specify an additional grant of rights to use that does not
|
|
101
|
+
impose any additional restriction on the right granted in this License,
|
|
102
|
+
as the Additional Use Grant; or (b) insert the text "None".
|
|
103
|
+
|
|
104
|
+
3. To specify a Change Date.
|
|
105
|
+
|
|
106
|
+
4. Not to modify this License in any other way.
|
|
107
|
+
|
|
108
|
+
-----------------------------------------------------------------------------
|
|
109
|
+
|
|
110
|
+
Notice
|
|
111
|
+
|
|
112
|
+
The Business Source License (this document, or the "License") is not an
|
|
113
|
+
Open Source license. However, the Licensed Work will eventually be made
|
|
114
|
+
available under an Open Source License, as stated in this License.
|
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# @tesseron/docs-mcp
|
|
2
|
+
|
|
3
|
+
[Tesseron](https://brainblend-ai.github.io/tesseron) documentation as an MCP server. Search and read the full protocol + SDK docs from any MCP-compatible AI client: Claude Code, Claude Desktop, Cursor, Windsurf, Zed, and anything else that speaks the [Model Context Protocol](https://modelcontextprotocol.io).
|
|
4
|
+
|
|
5
|
+
No network, no vector store, no API keys. The docs snapshot is bundled in the npm package at publish time. Search runs locally with BM25 over in-memory text.
|
|
6
|
+
|
|
7
|
+
## Why
|
|
8
|
+
|
|
9
|
+
If you are writing a Tesseron app, your AI assistant should know Tesseron. This server exposes the canonical Tesseron docs as three MCP tools (`list_docs`, `search_docs`, `read_doc`) plus `tesseron-docs://<slug>` resources so the agent can retrieve exact spec text before answering instead of guessing from training data.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
Nothing to install. Use `npx`.
|
|
14
|
+
|
|
15
|
+
## Configure your AI client
|
|
16
|
+
|
|
17
|
+
### Claude Code / Claude Desktop
|
|
18
|
+
|
|
19
|
+
Add to `~/.claude.json` or `~/.config/Claude/claude_desktop_config.json`:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"mcpServers": {
|
|
24
|
+
"tesseron-docs": {
|
|
25
|
+
"command": "npx",
|
|
26
|
+
"args": ["-y", "@tesseron/docs-mcp"]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Cursor
|
|
33
|
+
|
|
34
|
+
Add to `~/.cursor/mcp.json`:
|
|
35
|
+
|
|
36
|
+
```json
|
|
37
|
+
{
|
|
38
|
+
"mcpServers": {
|
|
39
|
+
"tesseron-docs": {
|
|
40
|
+
"command": "npx",
|
|
41
|
+
"args": ["-y", "@tesseron/docs-mcp"]
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Windsurf / Zed / any other MCP client
|
|
48
|
+
|
|
49
|
+
Point the client at `npx -y @tesseron/docs-mcp`. stdio transport, Node ≥ 20.
|
|
50
|
+
|
|
51
|
+
## Tools
|
|
52
|
+
|
|
53
|
+
| Tool | Input | Returns |
|
|
54
|
+
|---|---|---|
|
|
55
|
+
| `list_docs` | `{}` | `{ count, docs: Array<{ slug, title, section, description, related }> }` |
|
|
56
|
+
| `search_docs` | `{ query: string, limit?: number (1-20, default 8) }` | `{ query, count, hits: Array<{ slug, title, description, section, score, snippet }> }` |
|
|
57
|
+
| `read_doc` | `{ slug: string }` | `{ slug, title, description, section, related, body }` (body is full markdown) |
|
|
58
|
+
|
|
59
|
+
Slug format: `<section>/<basename>` without extension. Examples: `protocol/handshake`, `sdk/typescript/action-builder`, `examples/react-todo`.
|
|
60
|
+
|
|
61
|
+
## Resources
|
|
62
|
+
|
|
63
|
+
Each docs page is also exposed as an MCP resource at `tesseron-docs://<slug>`. Clients that prefer the resource surface over tools (Claude Desktop is one) get full listing via `list_resources` and full markdown bodies via `read_resource`.
|
|
64
|
+
|
|
65
|
+
## Search behaviour
|
|
66
|
+
|
|
67
|
+
- BM25 index via [minisearch](https://www.npmjs.com/package/minisearch).
|
|
68
|
+
- Fields: `title` (weight 3), `description` (weight 2), `bodyText` (weight 1).
|
|
69
|
+
- Fuzzy matching (`0.15`) and prefix matching are both on.
|
|
70
|
+
- Snippets are ~240 chars centred on the best match, with ellipses added when truncated.
|
|
71
|
+
|
|
72
|
+
## Dev / local use
|
|
73
|
+
|
|
74
|
+
Point the server at a local snapshot or set the env var:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# Build fresh snapshot from the monorepo docs tree.
|
|
78
|
+
pnpm --filter @tesseron/docs-mcp build:snapshot
|
|
79
|
+
|
|
80
|
+
# Run from source with a custom snapshot file.
|
|
81
|
+
pnpm --filter @tesseron/docs-mcp start -- --snapshot ./dist/docs-index.json
|
|
82
|
+
|
|
83
|
+
# Or via env var.
|
|
84
|
+
TESSERON_DOCS_SNAPSHOT=/abs/path/to/docs-index.json npx @tesseron/docs-mcp
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
The snapshot is rebuilt on every `pnpm build` (via `pnpm build:snapshot && tsup`) and on `prepublishOnly`.
|
|
88
|
+
|
|
89
|
+
## Versioning
|
|
90
|
+
|
|
91
|
+
`@tesseron/docs-mcp` versions track the docs snapshot, not the SDK. A new publish means the bundled docs were updated. It is unscoped from the `@tesseron/{core,web,server,react,mcp}` fixed-version bundle so SDK releases do not churn the docs package.
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
BUSL-1.1. See [LICENSE](./LICENSE).
|