auigrid-mcp-server 0.1.0 → 0.1.1
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 +24 -2
- package/dist/index.js +8 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,18 @@ An [MCP](https://modelcontextprotocol.io) server that gives AI coding assistants
|
|
|
4
4
|
|
|
5
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
6
|
|
|
7
|
+
## Quick install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Claude Code
|
|
11
|
+
claude mcp add auigrid -- npx -y auigrid-mcp-server
|
|
12
|
+
|
|
13
|
+
# Codex
|
|
14
|
+
codex mcp add auigrid -- npx -y auigrid-mcp-server
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
After registering, run `/mcp` in the session to confirm the server connected and its tools are visible.
|
|
18
|
+
|
|
7
19
|
## Tools
|
|
8
20
|
|
|
9
21
|
| Tool | Source | Purpose |
|
|
@@ -14,9 +26,11 @@ Data is built from AUIGrid's official documentation (`auisoft.net`) and its Reac
|
|
|
14
26
|
| `search_samples` / `get_sample` / `list_samples` | Bundled sample code | Real working React/TSX examples (tree grid, custom editors, drag & drop, export, ...) |
|
|
15
27
|
| `ping` | — | Health check |
|
|
16
28
|
|
|
17
|
-
##
|
|
29
|
+
## Manual config
|
|
30
|
+
|
|
31
|
+
If you'd rather edit the client config directly instead of using the CLI above:
|
|
18
32
|
|
|
19
|
-
|
|
33
|
+
**Claude Code / Claude Desktop** (`.mcp.json`, JSON):
|
|
20
34
|
|
|
21
35
|
```json
|
|
22
36
|
{
|
|
@@ -29,6 +43,14 @@ Add it to your MCP client config (e.g. `.mcp.json` for Claude Code, or Claude De
|
|
|
29
43
|
}
|
|
30
44
|
```
|
|
31
45
|
|
|
46
|
+
**Codex** (`~/.codex/config.toml`, TOML):
|
|
47
|
+
|
|
48
|
+
```toml
|
|
49
|
+
[mcp_servers.auigrid]
|
|
50
|
+
command = "npx"
|
|
51
|
+
args = ["-y", "auigrid-mcp-server"]
|
|
52
|
+
```
|
|
53
|
+
|
|
32
54
|
## Building from source
|
|
33
55
|
|
|
34
56
|
```bash
|
package/dist/index.js
CHANGED
|
@@ -9,6 +9,14 @@ import { searchStaticUtils, getStaticUtil } from "./lib/staticUtilsIndex.js";
|
|
|
9
9
|
const server = new McpServer({
|
|
10
10
|
name: "auigrid-mcp-server",
|
|
11
11
|
version: "0.1.0",
|
|
12
|
+
}, {
|
|
13
|
+
instructions: "Ground truth for the AUIGrid grid component API. Always call these tools before writing or reviewing " +
|
|
14
|
+
"AUIGrid code — do not guess prop names, event names, instance methods, or static utils from memory or " +
|
|
15
|
+
"training data; AUIGrid's naming does not follow common grid-library conventions and guesses are usually " +
|
|
16
|
+
"wrong. Use search_api/get_api_entry for grid options, Column fields, renderers, and events; " +
|
|
17
|
+
"search_methods/get_method for ref-based instance methods (setGridData, insertRow, ...); " +
|
|
18
|
+
"search_static_utils/get_static_util for AUIGrid.* namespace helpers; and search_samples/get_sample/" +
|
|
19
|
+
"list_samples for working React/TSX examples of a feature before implementing it from scratch.",
|
|
12
20
|
});
|
|
13
21
|
server.registerTool("ping", {
|
|
14
22
|
title: "Ping",
|
package/package.json
CHANGED