@casoon/opengrid-mcp 0.0.0-stage → 0.14.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-APACHE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/LICENSE-MIT ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License
2
+
3
+ Copyright (c) 2026 Jörn Seidel
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
13
+ all 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
21
+ THE SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,134 @@
1
- # Temporary Holding Version
1
+ # @casoon/opengrid-mcp
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [opengrid](https://github.com/casoon/opengrid)'s data grid as an
4
+ [MCP App](https://github.com/modelcontextprotocol/ext-apps): a chat client shows
5
+ the grid in the conversation, and the reader's keyboard and the model work on
6
+ **one** view. The model filters, sorts and groups by setting that view; the
7
+ reader does the same with the grid; each sees what the other did.
8
+
9
+ The rows stay with the server. The model gets columns, counts and — when the
10
+ reader hands them over — the selected rows, never a whole source.
11
+
12
+ ## Install
13
+
14
+ Claude Desktop runs the server locally; nothing is hosted. In **Settings →
15
+ Developer → Edit Config**:
16
+
17
+ ```json
18
+ {
19
+ "mcpServers": {
20
+ "opengrid": {
21
+ "command": "npx",
22
+ "args": ["-y", "@casoon/opengrid-mcp", "--config", "/path/to/opengrid-mcp.json"]
23
+ }
24
+ }
25
+ }
26
+ ```
27
+
28
+ Restart the app, then ask for a source: *"Open the orders as a grid."* Claude
29
+ asks once whether it may show the app.
30
+
31
+ Not yet tried in Claude Desktop or any other host: the tests run the view in a
32
+ test host of their own. A report of how it behaves in yours is welcome as an
33
+ [issue](https://github.com/casoon/opengrid/issues).
34
+
35
+ | Client | |
36
+ |---|---|
37
+ | Claude Desktop | local, as above |
38
+ | Claude Code | the tools work; a terminal shows no grid |
39
+ | claude.ai, ChatGPT | need a server reachable over HTTP (a custom connector); this package speaks stdio |
40
+
41
+ ## Sources
42
+
43
+ The operator decides what exists, in `opengrid-mcp.json`. Paths are relative to
44
+ the file:
45
+
46
+ ```json
47
+ {
48
+ "sources": {
49
+ "orders": {
50
+ "csv": "data/orders.csv",
51
+ "schema": "data/orders.schema.json",
52
+ "title": "Orders",
53
+ "columns": ["id", "customer", "country", "amount", "ordered_on"],
54
+ "fields": ["id", "customer", "country", "amount", "qty", "ordered_on"]
55
+ }
56
+ }
57
+ }
58
+ ```
59
+
60
+ | Key | |
61
+ |---|---|
62
+ | `csv`, `schema` | the data and its schema, as opengrid's `load_csv` reads them |
63
+ | `columns` | the grid's columns, in order — its `columns` attribute |
64
+ | `fields` | the fields any query may name; absent, every field of the schema |
65
+ | `title` | the grid's label |
66
+
67
+ The model names a source. It never names a path, writes SQL or reaches a
68
+ network, and a query naming a field outside `fields` is refused.
69
+
70
+ ### A source on an opengrid-server
71
+
72
+ A source can also live on an [`opengrid-server`](https://github.com/casoon/opengrid/blob/main/docs/guides/connectors.md),
73
+ reached by URL and token:
74
+
75
+ ```json
76
+ {
77
+ "sources": {
78
+ "orders": {
79
+ "server": { "url": "https://grid.example.com", "source": "orders", "tokenEnv": "ORDERS_TOKEN" },
80
+ "columns": ["id", "customer", "country", "amount"],
81
+ "title": "Orders"
82
+ }
83
+ }
84
+ }
85
+ ```
86
+
87
+ | Key | |
88
+ |---|---|
89
+ | `server.url` | the server; only the operator names it, never the model |
90
+ | `server.source` | the source's name there; absent, the name it has here |
91
+ | `server.tokenEnv` / `server.token` | the bearer token — preferably from an environment variable, so it is not in the file |
92
+
93
+ The server's rules hold as they are: its token, its allowed fields, its row
94
+ filter. There is no `fields` for such a source; the server narrows. The source
95
+ is described once when the MCP server starts. A server that refuses the token
96
+ stops the start with a sentence; one that cannot be reached does not — its
97
+ source answers `unavailable` and is described when it is next opened.
98
+
99
+ ## Tools
100
+
101
+ | Tool | Called by | |
102
+ |---|---|---|
103
+ | `opengrid_open` | model | Opens a source as a grid in the chat. Answers with the session, the columns and the count — no rows. |
104
+ | `opengrid_set_view` | model | Sets the whole view (opengrid's `get_view` JSON). A view naming an unknown column is refused as a whole. Answers with the new count. |
105
+ | `opengrid_describe` | model | What the reader sees: view, query, count, size of the selection. No rows. |
106
+ | `opengrid_selection` | model | The selected rows as `{ column: value }`, 100 by default, 500 at most; more are cut and said. |
107
+ | `opengrid_query` | grid only | The grid's own queries — its window, its counts. |
108
+ | `opengrid_sync` | grid only | The reader's changes in, the model's view out. |
109
+
110
+ **The model's view reaches a grid already shown** through the server: it keeps
111
+ each session's view, and the grid asks for it when it becomes visible or
112
+ focused and every few seconds while it is. It is applied in one step and said
113
+ once, with the result: *"52 matches · Filtered by the assistant"*. The focus
114
+ stays where it was.
115
+
116
+ **A selection** is the grid's query plus the positions the reader selected
117
+ under it. *Analyse the selection* hands it to the model, which reads the rows
118
+ with `opengrid_selection`.
119
+
120
+ ## How it runs in a client
121
+
122
+ MCP Apps hosts give a view a strict Content Security Policy: its own inline
123
+ code, nothing from elsewhere — and no WebAssembly. opengrid's elements are
124
+ WebAssembly, so this package carries them translated to JavaScript (wasm2js) and
125
+ inlined into one HTML file. The engine runs in the server, in Node.
126
+
127
+ ## Limits
128
+
129
+ The grid only — no pivot, no tree. No editing: a surface through which a model
130
+ could change data needs its own approval path.
131
+
132
+ ## Licence
133
+
134
+ MIT OR Apache-2.0, like opengrid.