genlayer-docs-mcp 0.1.0__tar.gz
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.
- genlayer_docs_mcp-0.1.0/LICENSE +21 -0
- genlayer_docs_mcp-0.1.0/PKG-INFO +158 -0
- genlayer_docs_mcp-0.1.0/README.md +134 -0
- genlayer_docs_mcp-0.1.0/pyproject.toml +51 -0
- genlayer_docs_mcp-0.1.0/src/genlayer_docs_mcp/__init__.py +1 -0
- genlayer_docs_mcp-0.1.0/src/genlayer_docs_mcp/__main__.py +4 -0
- genlayer_docs_mcp-0.1.0/src/genlayer_docs_mcp/genlayer-docs.txt +19754 -0
- genlayer_docs_mcp-0.1.0/src/genlayer_docs_mcp/server.py +174 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 GenLayer Labs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: genlayer-docs-mcp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Model Context Protocol (MCP) server for GenLayer documentation
|
|
5
|
+
Project-URL: Homepage, https://github.com/genlayerlabs/genlayer-docs-mcp
|
|
6
|
+
Project-URL: Repository, https://github.com/genlayerlabs/genlayer-docs-mcp
|
|
7
|
+
Project-URL: GenLayer Docs, https://docs.genlayer.com
|
|
8
|
+
Author: GenLayer Labs
|
|
9
|
+
License: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: ai,claude,documentation,genlayer,llm,mcp,model-context-protocol
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Requires-Dist: mcp>=1.2.0
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# GenLayer Documentation MCP Server
|
|
26
|
+
|
|
27
|
+
A standardized, shareable Model Context Protocol (MCP) server that packages and exposes the GenLayer documentation (`genlayer-docs.txt`) to any AI assistant (including Claude Desktop, Cursor, Windsurf, Gemini, and others).
|
|
28
|
+
|
|
29
|
+
By packaging this as a Python project with a `pyproject.toml` and utilizing the official `mcp` SDK, anyone can run it instantly with zero manual file path or dependency setup.
|
|
30
|
+
|
|
31
|
+
## Available Tools
|
|
32
|
+
|
|
33
|
+
Once registered, the server exposes the following tools:
|
|
34
|
+
|
|
35
|
+
1. **`search_docs(query: string, top_k: int = 5)`**:
|
|
36
|
+
Search the GenLayer documentation for relevant sections matching a query. Returns top matching sections along with their hierarchical title breadcrumbs (e.g., `What is GenLayer > Core Technology > On-Chain AI Processing`) and starting line numbers.
|
|
37
|
+
|
|
38
|
+
2. **`get_section(title: string)`**:
|
|
39
|
+
Retrieve the full content of a specific documentation section matching the specified heading title.
|
|
40
|
+
|
|
41
|
+
3. **`list_sections()`**:
|
|
42
|
+
List all headings and subheadings present in the GenLayer documentation along with their starting line numbers.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Universal Running & Setup Options
|
|
47
|
+
|
|
48
|
+
You can run this server using standard Python tools. We recommend using **`uv`** (a fast Python package manager) for a zero-install experience, or standard **`pip`/`pipx`**.
|
|
49
|
+
|
|
50
|
+
### Option A: Running Locally (For Development)
|
|
51
|
+
|
|
52
|
+
If you have cloned or downloaded this directory locally to `c:\Users\MueAb\Desktop\Genlayer mcp`:
|
|
53
|
+
|
|
54
|
+
#### 1. Claude Desktop Setup
|
|
55
|
+
Open your Claude configuration file (on Windows: `%APPDATA%\Claude\claude_desktop_config.json`) and add the server inside the `mcpServers` block:
|
|
56
|
+
|
|
57
|
+
* **Using `uvx` (Easiest, zero-install)**:
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"mcpServers": {
|
|
61
|
+
"genlayer-docs": {
|
|
62
|
+
"command": "uvx",
|
|
63
|
+
"args": [
|
|
64
|
+
"--from",
|
|
65
|
+
"c:\\Users\\MueAb\\Desktop\\Genlayer mcp",
|
|
66
|
+
"genlayer-docs-mcp"
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
* **Using installed python package**:
|
|
74
|
+
If you have installed the package via `pip install -e .` (or `pip install .`):
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"mcpServers": {
|
|
78
|
+
"genlayer-docs": {
|
|
79
|
+
"command": "python",
|
|
80
|
+
"args": [
|
|
81
|
+
"-m",
|
|
82
|
+
"genlayer_docs_mcp.server"
|
|
83
|
+
]
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### 2. Cursor IDE / Windsurf Setup
|
|
90
|
+
Register the server in your editor's MCP settings:
|
|
91
|
+
* **Type**: `command`
|
|
92
|
+
* **Command**: `uvx --from "c:\Users\MueAb\Desktop\Genlayer mcp" genlayer-docs-mcp`
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
### Option B: Publishing & Distributing to PyPI (For Everyone)
|
|
97
|
+
|
|
98
|
+
If you publish this package to PyPI (e.g., under the name `genlayer-docs-mcp`), **anyone in the world** can use it on **any AI client** instantly with zero local files!
|
|
99
|
+
|
|
100
|
+
#### 1. Claude Desktop Setup
|
|
101
|
+
Any user can simply add this to their `claude_desktop_config.json`:
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"mcpServers": {
|
|
105
|
+
"genlayer-docs": {
|
|
106
|
+
"command": "uvx",
|
|
107
|
+
"args": ["genlayer-docs-mcp"]
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### 2. Cursor IDE / Windsurf Setup
|
|
114
|
+
* **Type**: `command`
|
|
115
|
+
* **Command**: `uvx genlayer-docs-mcp`
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
### Option B2: Install directly from GitHub (no PyPI needed)
|
|
120
|
+
|
|
121
|
+
If you prefer not to wait for PyPI, or want to track the latest source, any user can run the server straight from the public GitHub repository:
|
|
122
|
+
|
|
123
|
+
* **Using `uvx` (zero-install)**:
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"mcpServers": {
|
|
127
|
+
"genlayer-docs": {
|
|
128
|
+
"command": "uvx",
|
|
129
|
+
"args": [
|
|
130
|
+
"--from",
|
|
131
|
+
"git+https://github.com/genlayerlabs/genlayer-docs-mcp",
|
|
132
|
+
"genlayer-docs-mcp"
|
|
133
|
+
]
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
* **Using `pip`**:
|
|
140
|
+
```bash
|
|
141
|
+
pip install "git+https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
### Option C: Installation via `pipx` or `pip`
|
|
147
|
+
Users who prefer not to use `uvx` can install the server globally using `pipx`:
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
# Install globally from PyPI
|
|
151
|
+
pipx install genlayer-docs-mcp
|
|
152
|
+
|
|
153
|
+
# Or install globally from GitHub
|
|
154
|
+
pipx install "git+https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Then configure the command in any AI client as:
|
|
158
|
+
* **Command**: `genlayer-docs-mcp` (no arguments required)
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# GenLayer Documentation MCP Server
|
|
2
|
+
|
|
3
|
+
A standardized, shareable Model Context Protocol (MCP) server that packages and exposes the GenLayer documentation (`genlayer-docs.txt`) to any AI assistant (including Claude Desktop, Cursor, Windsurf, Gemini, and others).
|
|
4
|
+
|
|
5
|
+
By packaging this as a Python project with a `pyproject.toml` and utilizing the official `mcp` SDK, anyone can run it instantly with zero manual file path or dependency setup.
|
|
6
|
+
|
|
7
|
+
## Available Tools
|
|
8
|
+
|
|
9
|
+
Once registered, the server exposes the following tools:
|
|
10
|
+
|
|
11
|
+
1. **`search_docs(query: string, top_k: int = 5)`**:
|
|
12
|
+
Search the GenLayer documentation for relevant sections matching a query. Returns top matching sections along with their hierarchical title breadcrumbs (e.g., `What is GenLayer > Core Technology > On-Chain AI Processing`) and starting line numbers.
|
|
13
|
+
|
|
14
|
+
2. **`get_section(title: string)`**:
|
|
15
|
+
Retrieve the full content of a specific documentation section matching the specified heading title.
|
|
16
|
+
|
|
17
|
+
3. **`list_sections()`**:
|
|
18
|
+
List all headings and subheadings present in the GenLayer documentation along with their starting line numbers.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Universal Running & Setup Options
|
|
23
|
+
|
|
24
|
+
You can run this server using standard Python tools. We recommend using **`uv`** (a fast Python package manager) for a zero-install experience, or standard **`pip`/`pipx`**.
|
|
25
|
+
|
|
26
|
+
### Option A: Running Locally (For Development)
|
|
27
|
+
|
|
28
|
+
If you have cloned or downloaded this directory locally to `c:\Users\MueAb\Desktop\Genlayer mcp`:
|
|
29
|
+
|
|
30
|
+
#### 1. Claude Desktop Setup
|
|
31
|
+
Open your Claude configuration file (on Windows: `%APPDATA%\Claude\claude_desktop_config.json`) and add the server inside the `mcpServers` block:
|
|
32
|
+
|
|
33
|
+
* **Using `uvx` (Easiest, zero-install)**:
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"mcpServers": {
|
|
37
|
+
"genlayer-docs": {
|
|
38
|
+
"command": "uvx",
|
|
39
|
+
"args": [
|
|
40
|
+
"--from",
|
|
41
|
+
"c:\\Users\\MueAb\\Desktop\\Genlayer mcp",
|
|
42
|
+
"genlayer-docs-mcp"
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
* **Using installed python package**:
|
|
50
|
+
If you have installed the package via `pip install -e .` (or `pip install .`):
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"mcpServers": {
|
|
54
|
+
"genlayer-docs": {
|
|
55
|
+
"command": "python",
|
|
56
|
+
"args": [
|
|
57
|
+
"-m",
|
|
58
|
+
"genlayer_docs_mcp.server"
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### 2. Cursor IDE / Windsurf Setup
|
|
66
|
+
Register the server in your editor's MCP settings:
|
|
67
|
+
* **Type**: `command`
|
|
68
|
+
* **Command**: `uvx --from "c:\Users\MueAb\Desktop\Genlayer mcp" genlayer-docs-mcp`
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
### Option B: Publishing & Distributing to PyPI (For Everyone)
|
|
73
|
+
|
|
74
|
+
If you publish this package to PyPI (e.g., under the name `genlayer-docs-mcp`), **anyone in the world** can use it on **any AI client** instantly with zero local files!
|
|
75
|
+
|
|
76
|
+
#### 1. Claude Desktop Setup
|
|
77
|
+
Any user can simply add this to their `claude_desktop_config.json`:
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"mcpServers": {
|
|
81
|
+
"genlayer-docs": {
|
|
82
|
+
"command": "uvx",
|
|
83
|
+
"args": ["genlayer-docs-mcp"]
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### 2. Cursor IDE / Windsurf Setup
|
|
90
|
+
* **Type**: `command`
|
|
91
|
+
* **Command**: `uvx genlayer-docs-mcp`
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
### Option B2: Install directly from GitHub (no PyPI needed)
|
|
96
|
+
|
|
97
|
+
If you prefer not to wait for PyPI, or want to track the latest source, any user can run the server straight from the public GitHub repository:
|
|
98
|
+
|
|
99
|
+
* **Using `uvx` (zero-install)**:
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"mcpServers": {
|
|
103
|
+
"genlayer-docs": {
|
|
104
|
+
"command": "uvx",
|
|
105
|
+
"args": [
|
|
106
|
+
"--from",
|
|
107
|
+
"git+https://github.com/genlayerlabs/genlayer-docs-mcp",
|
|
108
|
+
"genlayer-docs-mcp"
|
|
109
|
+
]
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
* **Using `pip`**:
|
|
116
|
+
```bash
|
|
117
|
+
pip install "git+https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
### Option C: Installation via `pipx` or `pip`
|
|
123
|
+
Users who prefer not to use `uvx` can install the server globally using `pipx`:
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
# Install globally from PyPI
|
|
127
|
+
pipx install genlayer-docs-mcp
|
|
128
|
+
|
|
129
|
+
# Or install globally from GitHub
|
|
130
|
+
pipx install "git+https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Then configure the command in any AI client as:
|
|
134
|
+
* **Command**: `genlayer-docs-mcp` (no arguments required)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "genlayer-docs-mcp"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Model Context Protocol (MCP) server for GenLayer documentation"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = { text = "MIT" }
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "GenLayer Labs" }
|
|
14
|
+
]
|
|
15
|
+
keywords = ["mcp", "model-context-protocol", "genlayer", "documentation", "llm", "ai", "claude"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 4 - Beta",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Programming Language :: Python :: 3.10",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"License :: OSI Approved :: MIT License",
|
|
24
|
+
"Operating System :: OS Independent",
|
|
25
|
+
"Topic :: Software Development :: Documentation",
|
|
26
|
+
]
|
|
27
|
+
dependencies = [
|
|
28
|
+
"mcp>=1.2.0",
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[project.urls]
|
|
32
|
+
Homepage = "https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
33
|
+
Repository = "https://github.com/genlayerlabs/genlayer-docs-mcp"
|
|
34
|
+
"GenLayer Docs" = "https://docs.genlayer.com"
|
|
35
|
+
|
|
36
|
+
[project.scripts]
|
|
37
|
+
genlayer-docs-mcp = "genlayer_docs_mcp.server:main"
|
|
38
|
+
|
|
39
|
+
[tool.hatch.build.targets.wheel]
|
|
40
|
+
packages = ["src/genlayer_docs_mcp"]
|
|
41
|
+
|
|
42
|
+
[tool.hatch.build.targets.wheel.force-include]
|
|
43
|
+
"src/genlayer_docs_mcp/genlayer-docs.txt" = "genlayer_docs_mcp/genlayer-docs.txt"
|
|
44
|
+
|
|
45
|
+
[tool.hatch.build.targets.sdist]
|
|
46
|
+
include = [
|
|
47
|
+
"src/genlayer_docs_mcp/**/*.py",
|
|
48
|
+
"src/genlayer_docs_mcp/genlayer-docs.txt",
|
|
49
|
+
"README.md",
|
|
50
|
+
"LICENSE",
|
|
51
|
+
]
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# GenLayer Docs MCP Package
|