@alaarab/ogrid-mcp 2.5.9 → 2.6.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/bundled-docs/api/README.md +20 -20
- package/bundled-docs/api/components-column-chooser.mdx +1 -1
- package/bundled-docs/api/components-column-header-filter.mdx +1 -1
- package/bundled-docs/api/components-datagrid-table.mdx +1 -1
- package/bundled-docs/api/components-pagination-controls.mdx +1 -1
- package/bundled-docs/api/components-sidebar.mdx +1 -1
- package/bundled-docs/api/components-status-bar.mdx +1 -1
- package/bundled-docs/api/js-api.mdx +2 -2
- package/bundled-docs/features/cell-references.mdx +9 -9
- package/bundled-docs/features/column-chooser.mdx +4 -1
- package/bundled-docs/features/column-groups.mdx +10 -3
- package/bundled-docs/features/column-pinning.mdx +7 -3
- package/bundled-docs/features/column-reordering.mdx +6 -4
- package/bundled-docs/features/column-types.mdx +1 -1
- package/bundled-docs/features/context-menu.mdx +8 -4
- package/bundled-docs/features/csv-export.mdx +7 -7
- package/bundled-docs/features/editing.mdx +21 -21
- package/bundled-docs/features/filtering.mdx +15 -15
- package/bundled-docs/features/formulas.mdx +27 -27
- package/bundled-docs/features/grid-api.mdx +2 -2
- package/bundled-docs/features/keyboard-navigation.mdx +5 -5
- package/bundled-docs/features/pagination.mdx +1 -1
- package/bundled-docs/features/row-selection.mdx +3 -2
- package/bundled-docs/getting-started/overview.mdx +7 -4
- package/bundled-docs/getting-started/quick-start.mdx +11 -11
- package/bundled-docs/getting-started/vanilla-js.mdx +26 -23
- package/bundled-docs/guides/accessibility.mdx +11 -11
- package/bundled-docs/guides/framework-showcase.mdx +18 -18
- package/bundled-docs/guides/mcp.mdx +9 -9
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@ sidebar_position: 1
|
|
|
6
6
|
|
|
7
7
|
# Editor Integration (MCP)
|
|
8
8
|
|
|
9
|
-
`@alaarab/ogrid-mcp` connects your AI coding assistant to OGrid documentation
|
|
9
|
+
`@alaarab/ogrid-mcp` connects your AI coding assistant to OGrid documentation — so instead of switching tabs to look things up, you can just ask your editor while you code.
|
|
10
10
|
|
|
11
11
|
It also includes a **live testing bridge** that lets your editor read and control an OGrid instance running in your browser in real time.
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ MCP (Model Context Protocol) is a standard that lets editors like Claude Code an
|
|
|
18
18
|
- Pull up specific API references without leaving your editor
|
|
19
19
|
- Inspect and interact with a running grid during development
|
|
20
20
|
|
|
21
|
-
You don't need to understand the protocol to use it
|
|
21
|
+
You don't need to understand the protocol to use it — just run one command and your editor gains access.
|
|
22
22
|
|
|
23
23
|
## Connect to your editor
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ You don't need to understand the protocol to use it. Run one command and your ed
|
|
|
28
28
|
claude mcp add ogrid -- npx -y @alaarab/ogrid-mcp
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
That's it. The docs are bundled in the package
|
|
31
|
+
That's it. The docs are bundled in the package — no config file needed.
|
|
32
32
|
|
|
33
33
|
### Claude Desktop
|
|
34
34
|
|
|
@@ -72,13 +72,13 @@ Show me how to use the formula engine in Vue.
|
|
|
72
72
|
Help me migrate from AG Grid to OGrid.
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
The MCP server searches through the full documentation
|
|
75
|
+
The MCP server searches through the full documentation — features, API references, getting started guides, and code examples — and returns the relevant sections along with your context.
|
|
76
76
|
|
|
77
77
|
---
|
|
78
78
|
|
|
79
79
|
## Available tools
|
|
80
80
|
|
|
81
|
-
These are what the MCP server provides to your editor. You don't call them directly
|
|
81
|
+
These are what the MCP server provides to your editor. You don't call them directly — your editor uses them automatically when you ask questions.
|
|
82
82
|
|
|
83
83
|
### `search_docs`
|
|
84
84
|
|
|
@@ -89,9 +89,9 @@ search_docs query="server-side data" framework="react"
|
|
|
89
89
|
```
|
|
90
90
|
|
|
91
91
|
Parameters:
|
|
92
|
-
- `query` (required)
|
|
93
|
-
- `framework` (optional)
|
|
94
|
-
- `category` (optional)
|
|
92
|
+
- `query` (required) — what you're looking for
|
|
93
|
+
- `framework` (optional) — `react`, `angular`, `vue`, or `js`
|
|
94
|
+
- `category` (optional) — `features`, `getting-started`, `guides`, or `api`
|
|
95
95
|
|
|
96
96
|
### `list_docs`
|
|
97
97
|
|
|
@@ -133,7 +133,7 @@ Resources can be read by your editor without calling a tool explicitly.
|
|
|
133
133
|
|
|
134
134
|
| Resource | Description |
|
|
135
135
|
|----------|-------------|
|
|
136
|
-
| `ogrid://quick-reference` | Key API overview
|
|
136
|
+
| `ogrid://quick-reference` | Key API overview — props, column definitions, IOGridApi, filter types |
|
|
137
137
|
| `ogrid://docs/{path}` | Any documentation page by path (e.g. `ogrid://docs/features/filtering`) |
|
|
138
138
|
| `ogrid://migration-guide` | Step-by-step guide for migrating from AG Grid to OGrid |
|
|
139
139
|
|