auigrid-mcp-server

An MCP server that gives AI coding assistants (Claude Code, Claude Desktop, Cursor, etc.) direct, searchable access to the AUIGrid 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.

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.

Quick install

# Claude Code
claude mcp add auigrid -- npx -y auigrid-mcp-server

# Codex
codex mcp add auigrid -- npx -y auigrid-mcp-server

After registering, run /mcp in the session to confirm the server connected and its tools are visible.

Tools

| Tool | Source | Purpose | |---|---|---| | search_api / get_api_entry | .d.ts + Properties/Events docs | Grid options, Column fields, renderers, events (name, type, default, description, examples) | | search_methods / get_method | Methods doc | Instance methods called via ref, e.g. setGridData, insertRow, exportToCsv | | search_static_utils / get_static_util | StaticUtils doc | Namespace-level helpers, e.g. AUIGrid.formatDate(), AUIGrid.create() | | search_samples / get_sample / list_samples | Bundled sample code | Real working React/TSX examples (tree grid, custom editors, drag & drop, export, ...) | | ping | — | Health check |

Manual config

If you'd rather edit the client config directly instead of using the CLI above:

Claude Code / Claude Desktop (.mcp.json, JSON):

{
  "mcpServers": {
    "auigrid": {
      "command": "npx",
      "args": ["-y", "auigrid-mcp-server"]
    }
  }
}

Codex (~/.codex/config.toml, TOML):

[mcp_servers.auigrid]
command = "npx"
args = ["-y", "auigrid-mcp-server"]

Building from source

npm install
npm run build   # compiles TypeScript, then re-runs all indexers against vendor/
npm start        # runs the server on stdio

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/.

License

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.