@grafana/viz-contract 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+Each version of the contract has one entry. [8-versioning.md](8-versioning.md) gives the version rules. An entry
+marked `internal` changes only an interface with the internal or the provisional promise.
+
+## 1.1.0
+
+`internal`
+
+- `render_grafana_app` adds the notes of the Source after its text line (`tool.28`, `tool.30`). New constants
+  `maxAppNotes` and `maxAppNoteChars`. `tool.26` is removed.
+- The Source gives one note for each entry of `data.results` that has an `error` (`tool.29`).
+- `future.md` loses item 1, failures in the text result.
+
+## 1.0.0
+
+- First version.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Grafana Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,140 @@
+# Grafana visualization contract
+
+A model in an MCP client asks Grafana for a chart. The `query_datasource` source of the `render_grafana_app` tool
+in `grafana/mcp-grafana` runs the query. The App, an MCP Apps view, gets the result. The Renderer draws the chart.
+
+This contract gives the shapes and the rules that pass between these parts. A part that follows the contract
+works with the other parts. Its engineers do not have to ask the engineers of the other parts.
+
+## Parts
+
+```mermaid
+flowchart TB
+  subgraph Host["Host"]
+    Model["Model"]
+    subgraph App["App: ui://grafana/app.html"]
+      Renderer["Renderer"]
+    end
+  end
+  subgraph Server["mcp-grafana"]
+    Source["Source: query_datasource"]
+  end
+  Grafana["Grafana: /api/ds/query"]
+
+  Model -- "1. render_grafana_app" --> Source
+  Source -- "2. query" --> Grafana
+  Source -- "3. tool result" --> App
+  App -- "4. viz spec" --> Renderer
+  Renderer -- "5. state, notices, onRefresh" --> App
+  App -- "6. model context" --> Model
+  App -- "7. render_grafana_app again" --> Source
+```
+
+| Interface | From | To | Files |
+| --------- | ---- | -- | ----- |
+| Tool arguments | Model | Source | [1-tool.md](1-tool.md), `schemas/query-datasource-args.schema.json` |
+| Tool result | Source | App | [1-tool.md](1-tool.md), `schemas/tool-result.schema.json` |
+| Viz spec | App | Renderer | [2-viz-spec.md](2-viz-spec.md), `schemas/viz-spec.schema.json` |
+| Renderer API | App | Renderer | [3-renderer.md](3-renderer.md), `renderer-api.d.ts` |
+| States, notices and model context | Renderer, App | App, Model | [4-states-and-notices.md](4-states-and-notices.md) |
+| Refresh | Renderer, App | App, Source | [5-refresh.md](5-refresh.md) |
+
+## Terms
+
+| Term | Meaning |
+| ---- | ------- |
+| Host | The MCP client that shows the App, for example Claude web and Desktop, Cursor and ChatGPT |
+| Source | The Go code in mcp-grafana that runs the query (`query_datasource` in `render_grafana_app`) |
+| App | The view in `ui://grafana/app.html` of mcp-grafana that gets the tool result and calls the Renderer |
+| Renderer | The browser bundle that draws a viz spec |
+| Viz spec | The JSON object that the App gives to the Renderer |
+| Note | A text line that the Source gives to `render_grafana_app`, and that the model reads in the same turn (`tool.28`). Not a notice: the Renderer shows a notice in the chart (`state.7`) |
+
+The Renderer draws the panels of the package `@plugins/grafana-echarts`.
+
+## How to read
+
+1. Files 1 to 5 give the interfaces in build order. Files 6 to 8 apply to all of them.
+2. Read the files of your part only:
+
+   | Part | Files |
+   | ---- | ----- |
+   | Source | 1, 6, 8, the schemas of the tool arguments and the tool result, and `registry/` |
+   | App | 1 to 8, and the registries of states, notices and constants |
+   | Renderer | 2 to 8, `renderer-api.d.ts`, and the registries of panel types, states, notices and constants |
+
+3. The schemas give the shapes. The prose gives the behavior only, and does not repeat a schema.
+   `schemas/bundled/` holds each schema as one file with no reference to another file. Consumers use the bundled
+   files.
+4. Each rule has a stable ID: a file prefix, a dot and a number, for example `refresh.3`. A test names the ID of
+   the rule that it checks. An ID never gets a new meaning. The ID of a removed rule is not used again.
+5. "Must" is a requirement. "Can" is a permission.
+6. The prose names a fixed value by its constant, for example `maxResultBytes`. The value is in
+   `registry/constants.json` and in the table below.
+
+## Use the package
+
+The npm package `@grafana/viz-contract` holds the bundled schemas, the registries, the fixtures and the types of
+the Renderer API. Each package version is a contract version.
+
+```sh
+npm install --save-dev @grafana/viz-contract
+```
+
+```ts
+import panelTypes from '@grafana/viz-contract/registry/panel-types.json' with { type: 'json' };
+import vizSpecSchema from '@grafana/viz-contract/schemas/viz-spec.schema.json' with { type: 'json' };
+import type { RenderOptions } from '@grafana/viz-contract/renderer-api';
+```
+
+`renderer-api` has types only. Import it with `import type`. The functions that it declares come from the Renderer.
+
+A test that reads all fixtures finds the folder like this:
+
+```ts
+import { createRequire } from 'node:module';
+import path from 'node:path';
+
+const pkg = createRequire(import.meta.url).resolve('@grafana/viz-contract/package.json');
+const fixturesDir = path.join(path.dirname(pkg), 'fixtures');
+```
+
+## Promises
+
+The interfaces do not have the same promise of stability. [8-versioning.md](8-versioning.md) gives the three
+promises and the promise of each interface.
+
+The tool result, the viz spec and the Renderer API have the internal promise. They can change in any minor
+version, with no deprecation period. If you build on them outside mcp-grafana and the Renderer, pin a tagged
+version.
+
+## Constants
+
+<!-- constants:start. A script makes this table from registry/constants.json. Do not edit it. -->
+| Name | Value | Unit | Changeable | Meaning |
+| ---- | ----- | ---- | ---------- | ------- |
+| `maxResultBytes` | 1048576 | bytes | yes | Largest structuredContent of the tool result |
+| `refreshTimeoutMs` | 60000 | ms | no | Time before a refresh with no result fails |
+| `defaultHeightPx` | 400 | px | no | Chart height when the element height is 0 |
+| `defaultFrom` | now-1h | time | no | from when the tool arguments have none |
+| `defaultTo` | now | time | no | to when the tool arguments have none |
+| `defaultMaxDataPoints` | 1000 | points | no | maxDataPoints of a query that has none. intervalMs is the range divided by it |
+| `maxSeries` | 50 | series | yes | Most series that the Renderer draws |
+| `maxBundleGzipBytes` | not set | bytes | yes | Largest gzip size of the Renderer bundle. Not set until the host size research is done |
+| `maxAppNotes` | 5 | notes | yes | Most notes of the Source that render_grafana_app adds to its text line |
+| `maxAppNoteChars` | 200 | characters | yes | Longest note in the text line of render_grafana_app |
+| `deprecationDays` | 30 | days | yes | Shortest deprecation period of a change to a frozen interface |
+| `specVersion` | 1 | version | no | The viz spec version that this contract gives |
+<!-- constants:end -->
+
+## Not in this contract
+
+1. Behavior inside one part. For example, zoom, pan and the Reset button are Renderer UI.
+2. Size changes and display modes between the App and the Host. The
+   [MCP Apps specification](https://github.com/modelcontextprotocol/ext-apps) gives them.
+3. Items that are not specified yet. [future.md](future.md) lists them in priority order.
+
+## Changes
+
+[CHANGELOG.md](CHANGELOG.md) lists the versions. [CONTRIBUTING.md](CONTRIBUTING.md) gives the steps to change the
+contract.

package/fixtures/epoch-range/args.json

@@ -0,0 +1,14 @@
+{
+  "datasourceUid": "lgtm-prometheus",
+  "queries": [
+    {
+      "refId": "A",
+      "expr": "sum by (handler) (rate(grafana_http_request_duration_seconds_count[5m]))",
+      "legendFormat": "{{handler}}",
+      "format": "time_series"
+    }
+  ],
+  "from": 1790349877294,
+  "to": 1790353477294,
+  "unit": "reqps"
+}

package/fixtures/epoch-range/meta.json

@@ -0,0 +1,4 @@
+{
+  "now": 1790353477294,
+  "capturedAt": 1790353477806
+}

package/fixtures/epoch-range/request.json

@@ -0,0 +1,17 @@
+{
+  "from": "1790349877294",
+  "to": "1790353477294",
+  "queries": [
+    {
+      "refId": "A",
+      "expr": "sum by (handler) (rate(grafana_http_request_duration_seconds_count[5m]))",
+      "legendFormat": "{{handler}}",
+      "format": "time_series",
+      "datasource": {
+        "uid": "lgtm-prometheus"
+      },
+      "maxDataPoints": 1000,
+      "intervalMs": 3600
+    }
+  ]
+}

package/fixtures/epoch-range/response.json

@@ -0,0 +1,114 @@
+{
+  "status": 200,
+  "body": {
+    "results": {
+      "A": {
+        "status": 200,
+        "frames": [
+          {
+            "schema": {
+              "refId": "A",
+              "meta": {
+                "type": "timeseries-multi",
+                "typeVersion": [
+                  0,
+                  1
+                ]
+              },
+              "fields": [
+                {
+                  "name": "Time",
+                  "type": "time",
+                  "typeInfo": {
+                    "frame": "time.Time"
+                  }
+                },
+                {
+                  "name": "Value",
+                  "type": "number",
+                  "typeInfo": {
+                    "frame": "float64"
+                  },
+                  "labels": {
+                    "handler": "/api/ds/query"
+                  },
+                  "config": {
+                    "displayNameFromDS": "/api/ds/query"
+                  }
+                }
+              ]
+            },
+            "data": {
+              "values": [
+                [
+                  1790351737294,
+                  1790351797294,
+                  1790351857294,
+                  1790351917294,
+                  1790351977294,
+                  1790352037294,
+                  1790352097294,
+                  1790352157294,
+                  1790352217294,
+                  1790352277294,
+                  1790352337294,
+                  1790352397294,
+                  1790352457294,
+                  1790352517294,
+                  1790352577294,
+                  1790352637294,
+                  1790352697294,
+                  1790352757294,
+                  1790352817294,
+                  1790352877294,
+                  1790352937294,
+                  1790352997294,
+                  1790353057294,
+                  1790353117294,
+                  1790353177294,
+                  1790353237294,
+                  1790353297294,
+                  1790353357294,
+                  1790353417294,
+                  1790353477294
+                ],
+                [
+                  12,
+                  12.65,
+                  13.24,
+                  13.68,
+                  13.94,
+                  13.99,
+                  13.82,
+                  13.45,
+                  12.91,
+                  12.28,
+                  11.62,
+                  11,
+                  10.49,
+                  10.14,
+                  10,
+                  10.08,
+                  10.37,
+                  10.84,
+                  11.44,
+                  12.1,
+                  12.75,
+                  13.31,
+                  13.73,
+                  13.97,
+                  13.98,
+                  13.77,
+                  13.38,
+                  12.82,
+                  12.18,
+                  11.52
+                ]
+              ]
+            }
+          }
+        ]
+      }
+    }
+  }
+}