auigrid-mcp-server 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/LICENSE +21 -0
- package/README.md +44 -0
- package/data/api-index.json +8069 -0
- package/data/methods-index.json +3127 -0
- package/data/samples-index.json +163 -0
- package/data/static-utils-index.json +229 -0
- package/dist/build-index.js +95 -0
- package/dist/build-methods-index.js +14 -0
- package/dist/build-samples-index.js +46 -0
- package/dist/build-static-utils-index.js +12 -0
- package/dist/enrich-api-index.js +50 -0
- package/dist/index.js +226 -0
- package/dist/lib/apiIndex.js +40 -0
- package/dist/lib/docPageParser.js +101 -0
- package/dist/lib/methodsIndex.js +32 -0
- package/dist/lib/samplesIndex.js +52 -0
- package/dist/lib/staticUtilsIndex.js +29 -0
- package/package.json +46 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Hansang
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# auigrid-mcp-server
|
|
2
|
+
|
|
3
|
+
An [MCP](https://modelcontextprotocol.io) server that gives AI coding assistants (Claude Code, Claude Desktop, Cursor, etc.) direct, searchable access to the [AUIGrid](https://www.auisoft.net/) API reference — grid options, columns, cell/edit/header renderers, events, instance methods, static utilities, and real sample code — so they can write correct AUIGrid code without guessing at prop names or hallucinating methods.
|
|
4
|
+
|
|
5
|
+
Data is built from AUIGrid's official documentation (`auisoft.net`) and its React/TSX type declarations, indexed ahead of time into a local JSON knowledge base the server searches at runtime.
|
|
6
|
+
|
|
7
|
+
## Tools
|
|
8
|
+
|
|
9
|
+
| Tool | Source | Purpose |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| `search_api` / `get_api_entry` | `.d.ts` + Properties/Events docs | Grid options, `Column` fields, renderers, events (name, type, default, description, examples) |
|
|
12
|
+
| `search_methods` / `get_method` | Methods doc | Instance methods called via `ref`, e.g. `setGridData`, `insertRow`, `exportToCsv` |
|
|
13
|
+
| `search_static_utils` / `get_static_util` | StaticUtils doc | Namespace-level helpers, e.g. `AUIGrid.formatDate()`, `AUIGrid.create()` |
|
|
14
|
+
| `search_samples` / `get_sample` / `list_samples` | Bundled sample code | Real working React/TSX examples (tree grid, custom editors, drag & drop, export, ...) |
|
|
15
|
+
| `ping` | — | Health check |
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Add it to your MCP client config (e.g. `.mcp.json` for Claude Code, or Claude Desktop's config):
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"mcpServers": {
|
|
24
|
+
"auigrid": {
|
|
25
|
+
"command": "npx",
|
|
26
|
+
"args": ["-y", "auigrid-mcp-server"]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Building from source
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install
|
|
36
|
+
npm run build # compiles TypeScript, then re-runs all indexers against vendor/
|
|
37
|
+
npm start # runs the server on stdio
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
`npm run build` regenerates `data/*.json` from the vendored sources in `vendor/` (AUIGrid's type declarations and the scraped `auisoft.net` doc pages). Re-run it after updating anything under `vendor/`.
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
MIT for the server code. AUIGrid itself is a commercial product of AUISoft Co., Ltd. — this project only republishes its publicly available documentation for the purpose of API lookup; it has no affiliation beyond that.
|