{"_id":"ag-mcp","_rev":"2-310f2581a04da1ecaeb27b255f9fa920","name":"ag-mcp","dist-tags":{"beta":"0.0.1-beta.1","latest":"1.0.0"},"versions":{"0.0.1-beta.1":{"name":"ag-mcp","version":"0.0.1-beta.1","keywords":[],"author":"","license":"MIT","_id":"ag-mcp@0.0.1-beta.1","maintainers":[{"name":"seanlandsman","email":"sean@thelandsmans.com"}],"dist":{"shasum":"c5e5cab655100490f52dbef3f01fc51742524bf6","tarball":"https://registry.npmjs.org/ag-mcp/-/ag-mcp-0.0.1-beta.1.tgz","fileCount":2,"integrity":"sha512-QBTNz9r/cBdNK6ntkJsbVOCZ1t5fUy3VIa1lP+NlOMEKzeSvXFTNIgY2ysCQTErvflHmaFJHGLf8CWb0AefukA==","signatures":[{"sig":"MEQCIEi2ZCQK6+dZKG0Zzo+ozLvFd9N1/rnqjcuJhMTHz+6gAiBrn45Z8gMlUarGtzz9YmFXMsqNxmDqZC8dKz+qGkE21Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":255},"main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"seanlandsman","actor":{"name":"seanlandsman","type":"user","email":"sean@thelandsmans.com"},"email":"sean@thelandsmans.com"},"_npmVersion":"10.2.4","directories":{},"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/ag-mcp_0.0.1-beta.1_1751998046959_0.319875246180956","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"ag-mcp","version":"1.0.0","description":"MCP server for AG-Grid to help developers integrate AG Grid into their applications","main":"dist/index.js","bin":{"ag-mcp":"dist/index.js"},"type":"module","scripts":{"build":"tsc","dev":"tsx src/index.ts","start":"node dist/index.js","test":"vitest","updateBetaVersion":"tsx ./scripts/updateBetaVersion.ts","publish:dev:dry-run":"npm run updateBetaVersion && npm publish . --dry-run --registry http://52.50.158.57:4873/ --tag beta","publish:dev":"npm run updateBetaVersion && npm publish . --registry http://52.50.158.57:4873/ --tag beta"},"keywords":["ag-grid","mcp","model-context-protocol","datagrid","assistant","llm"],"author":{"name":"AG Grid"},"license":"MIT","dependencies":{"@modelcontextprotocol/sdk":"^1.0.0","ag-grid-community":"latest","env-paths":"^3.0.0","local-pkg":"^1.1.2","node-fetch":"^3.3.2","package-manager-detector":"^1.3.0","zod":"^4.0.5"},"devDependencies":{"@types/node":"^20.11.0","tsx":"^4.20.5","typescript":"~5.2.2","vitest":"^2.1.6"},"engines":{"node":">=18.0.0"},"_id":"ag-mcp@1.0.0","gitHead":"c708af4694877c1e0e9380e7c263c2a3149bb475","types":"./dist/index.d.ts","_nodeVersion":"20.19.4","_npmVersion":"10.8.2","dist":{"integrity":"sha512-xL5vmI4NK+uJuverlhn513ludXowKWQoNAOw7LVkkfSJpsmV2L6jeKCGtfJqYVRQFYvoxfDohcJ2TOF1fcDcAA==","shasum":"7b7b6b373c208c3517892055b779fb585c6afd6e","tarball":"https://registry.npmjs.org/ag-mcp/-/ag-mcp-1.0.0.tgz","fileCount":90,"unpackedSize":145772,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEMCIEw6mhStflyYFntXYcH2SQRo4ZZjCr0iEDuUXG3/0NW7Ah9vko98yDcay0CtmYhgmVC5EW/n7r+slV4tiEmxEuli"}]},"_npmUser":{"name":"seanlandsman","email":"sean@thelandsmans.com"},"directories":{},"maintainers":[{"name":"seanlandsman","email":"sean@thelandsmans.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ag-mcp_1.0.0_1758443359947_0.5654718621461423"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-08T18:07:26.958Z","modified":"2025-09-21T08:29:20.298Z","0.0.1-beta.1":"2025-07-08T18:07:27.115Z","1.0.0":"2025-09-21T08:29:20.118Z"},"license":"MIT","keywords":["ag-grid","mcp","model-context-protocol","datagrid","assistant","llm"],"maintainers":[{"name":"seanlandsman","email":"sean@thelandsmans.com"}],"readme":"# AG Grid Model Context Protocol (MCP) Server\n\n
\n \n \n \n \n \"AG\n \n \n \n

AG Grid's Model Context Protocol (MCP) server provides AI Agents with framework and version specific knowledge to help developers integrate and maintain their AG Grid code.

\n \n
\n

🌐 Website • 📖 Documentation • 🏘️ Community

\n
\n
\n \"NPM\n \n

\n
\n\n## Overview\n\nThe `ag-mcp` server works with any LLM that supports MCPs, and provides tools to allow LLMs to lookup framework and version specific documentation, examples, and references to help create, modify, maintain, and upgrade your data grid code.\n\nThe core feature of the AG MCP Server is an LLM optimized search tool which will provide documentation, examples, API definitions and references. The content is provided in a condensed markdown so as to minimise the amount of context used, and not overwhelm the LLM.\n\nAG-MCP also provides pre-built [prompts](#prompts) to simplify the process of [creating new grids](#quick-start), and [migrating to later versions](#migrations--upgrades).\n\n### Architecture Diagram\n\n```mermaid\nflowchart LR\n subgraph LLM[\"LLM Providers\"]\n A1[Claude]\n A2[ChatGPT]\n A3[Gemini]\n A4[...]\n end\n\n subgraph Developer[\"Developer\"]\n D[Developer]\n end\n\n subgraph MCP_Client[\"MCP Clients\"]\n direction RL\n B1[Claude Code]\n B2[Copilot]\n B3[Windsurf]\n B4[Cursor]\n B5[...]\n end\n\n subgraph ag-mcp[\"AG Grid MCP Server\"]\n subgraph Tools[\"Tools\"]\n C1[Detect / Set Version]\n C2[Search AG Grid Docs]\n end\n\n C3[AG Grid Docs & Examples]\n\n subgraph Prompts[\"Prompts\"]\n C4[Bootstrap Grid]\n C5[Upgrade Grid]\n end\n end\n\n %% Connections\n A1 --> MCP_Client\n A2 --> MCP_Client\n A3 --> MCP_Client\n A4 --> MCP_Client\n\n D --> MCP_Client\n\n MCP_Client --> C1\n MCP_Client --> C2\n MCP_Client --> C3\n MCP_Client --> C4\n MCP_Client --> C5\n\n C1 --> MCP_Client\n C2 --> MCP_Client\n C3 --> MCP_Client\n C4 --> MCP_Client\n C5 --> MCP_Client\n\n %% Styling\n classDef llmStyle fill:#e1f5fe,stroke:#0288d1,stroke-width:3px,color:#01579b\n classDef clientStyle fill:#f3e5f5,stroke:#7b1fa2,stroke-width:3px,color:#4a148c\n classDef toolStyle fill:#fff3e0,stroke:#f57c00,stroke-width:2px,color:#e65100\n classDef promptStyle fill:#e8f5e9,stroke:#43a047,stroke-width:2px,color:#1b5e20\n classDef docStyle fill:#fce4ec,stroke:#c2185b,stroke-width:2px,color:#880e4f\n classDef developerStyle fill:#e0f2f1,stroke:#00897b,stroke-width:3px,color:#004d40\n classDef serverStyle fill:#fff8e1,stroke:#ffa000,stroke-width:4px,color:#ff6f00\n\n class A1,A2,A3,A4 llmStyle\n class B1,B2,B3,B4,B5 clientStyle\n class C1,C2 toolStyle\n class C4,C5 promptStyle\n class C3 docStyle\n class D developerStyle\n class ag-mcp serverStyle\n\n %% Link styling\n linkStyle default stroke:#666,stroke-width:2px,fill:none\n\n```\n\n## Installation\n\nTo install and use `ag-mcp` with your LLM client, provide the `npx ag-mcp` command in the normal process for adding an MCP Server.\n\n### Cursor\n\n[![Install in Cursor](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en/install-mcp?name=ag-mcp&config=eyJjb21tYW5kIjoibnB4IGFnLW1jcCJ9)\n\nTo open Cursor and automatically add the `ag-mcp` server, click the 'Add to Cursor' button.\n\nTo install manually, create a `mcp.json` file in the root of your project and add the following:\n\n```json\n{\n \"mcpServers\": {\n \"ag-mcp\": {\n \"command\": \"npx\",\n \"args\": [\"ag-mcp\"]\n }\n }\n}\n```\n\nTo learn more, see the [Cursor MCP documentation](https://cursor.com/docs/context/mcp)\n\n### VS Code (Copilot)\n\n[![Install in VS Code]()](vscode:mcp/install?%7B%22ag-mcp%22%3A%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22ag-mcp%22%5D%7D%7D)\n\nTo open VS Code and automatically add the `ag-mcp` server, click the 'Install in VS Code' link.\n\nTo install manually, create a `.vscode/mcp.json` file in your workspace, and add the following:\n\n```bash\n\"ag-mcp\": {\n \"type\": \"stdio\",\n \"command\": \"npx\",\n \"args\": [\n \"ag-mcp\",\n \"${input:stdio-arg}\"\n ],\n \"env\": {}\n}\n```\n\nTo learn more, see the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers).\n\n### Claude Code\n\nTo add `ag-mcp` to Claude code, run the following command:\n\n```bash\nclaude mcp add ag-mcp npx ag-mcp\n```\n\nTo learn more, see the [Claude MCP documentation](https://docs.claude.com/en/docs/claude-code/mcp)\n\n## Usage\n\nOnce the MCP is installed, your LLM will automatically take advantage of all the [Tools](#tools) and [Resources](#resources) available. Tools and Resources can also be accessed manually - refer to your LLM documentation for specific instructions.\n\n### Prompts\n\nPrompts are pre-configured actions that allow you to perform common actions, such as creating a new grid, or migrating to a later version.\n\n- [`quick-start`](#quick-start) - Get started with AG-Grid in any framework\n- [`upgrade-grid`](#migrations--upgrades) - Migrate to a newer version of AG-Grid\n\n#### Quick Start\n\nThe `quick-start` prompt can be triggered directly from your LLM client. This creates a list of instructions for you LLM to follow when creating a new AG Grid project or adding AG Grid to an existing project.\n\nYou can pass additional context, requirements or instructions to your LLM as arguments to this prompt to fine tune the type of data grid you want the LLM to create.\n\n#### Migrations & Upgrades\n\nThe `upgrade-grid` prompt creates a step by step plan to help migrate from your current version to the provided version. This is given to the LLM to execute, calling back to the MCP server as needed. It takes a version by version approach, making sure each version is correct before continuing.\n\n### Config\n\nConfig, such as project roots and versions, is stored in your cache folder. For example, in MacOS it will be stored in `~/Library/Preferences/ag-mcp`.\n\n### Resources (Docs, API & Example Search)\n\nThe core feature of the AG MCP Server is an LLM optimized search tool which will provide documentation, examples, and API definitions/interfaces. The content is provided in a condensed markdown so as to minimise the amount of context used, and not overwhelm the LLM.\n\nThere are currently three sets of resources available:\n\n- `articles` - Access to the full AG Grid documentation at the correct version.\n- `definitions` - API definitions and interfaces\n- `examples` - A library of AG Grid implementation examples in your framework.\n\nYour LLM can access these resources whenever it needs more information on how to implement AG Grid features. Refer to your LLM documentation for accessing these resources manually.\n\n### Tools\n\nTools are schema-defined interfaces that enable AI models to perform actions. Each tool defines a specific operation with typed inputs and outputs, and the model automatically requests tool execution based on context.\n\nTools can be called manually by entering the tool name as a prompt into your LLM, and passing the relevant params. Refer to your LLM documentation for specific instructions.\n\nAG-MCP currently provides four tools:\n\n- [`search_docs`](#search-docs) - Search the documents for the currently installed version of AG Grid.\n- [`detect_version`](#detect-version) - Infers the version and framework of AG Grid installed in your repo.\n- [`set_version`](#set-version) - Manually set the version of your repo (useful in monorepos).\n- `list_versions` - List all available AG Grid versions from the API to see what versions are available for migration or reference.\n\n#### Search Docs\n\nSearch AG Grid documentation for the detected or latest version. Use this to find details on features, APIs, configurations, and troubleshooting. Supports natural language queries.\n\n##### Parameters\n\n| Name | Type | Required | Description |\n| --------- | ------ | -------- | ------------------------------------------------------------------------------------- |\n| query | string | Yes | Search term (e.g., `\"column sorting\"`, `\"cell renderers\"`, `\"data grid performance\"`) |\n| version | string | No | Override the detected AG Grid version |\n| framework | string | No | Override the detected framework |\n\n#### Detect Version\n\nDetect the AG Grid version and framework in the current project by analyzing package.json and dependencies. Use this to understand the project setup.\n\n##### Parameters\n\n| Name | Type | Required | Description |\n| ---- | ------ | -------- | ------------------------------------------------------------- |\n| path | string | No | Path to the project directory (defaults to current workspace) |\n\n#### Set Version\n\nSet the AG Grid version and framework to use for documentation searches and resources. Use this when working with a specific version or framework combination.\n\n##### Parameters\n\n| Name | Type | Required | Description |\n| --------- | ------ | -------- | ------------------------------------------------------------------------- |\n| version | string | Yes | AG Grid version to use (e.g., `\"34.1.0\"`) |\n| framework | string | Yes | Framework to use for documentation (`react`, `angular`, `vue`, `vanilla`) |\n","readmeFilename":"README.md","description":"MCP server for AG-Grid to help developers integrate AG Grid into their applications","author":{"name":"AG Grid"}}