Grafana ACTION
Create Annotation
Create an annotation on a dashboard or globally. Annotations mark events like deployments, incidents, or configuration changes on dashboard timelines. Use Search Dashboards to find the dashboard UID. Omit
dashboardUid for a global annotation visible on all dashboards. Use time and timeEnd for range annotations (e.g., deployment window).- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Grafana account once, then configure and run Create Annotation from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "grafana-create-annotation",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
grafana: { authProvisionId: "apn_xxxxxxx" },
text: "Text",
dashboardUid: "Dashboard UID",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "grafana-create-annotation",
"configured_props": {
"grafana": { "authProvisionId": "apn_xxxxxxx" },
"text": "Text",
"dashboardUid": "Dashboard UID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "grafana",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "grafana-create-annotation",
arguments: {
text: "Text",
dashboardUid: "Dashboard UID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
text Text | string | Annotation text/description. Required |
dashboardUid Dashboard UID | string | Dashboard to annotate. Omit for a global annotation visible on all dashboards. Use Search Dashboards to find the UID. Optional |
panelId Panel ID | integer | Specific panel within the dashboard to annotate. Optional |
tags Tags | string[] | Tags for filtering annotations. Optional |
time Start Time | integer | Start time as epoch milliseconds. Default: now. Optional |
timeEnd End Time | integer | End time as epoch milliseconds for range annotations. Omit for a point-in-time annotation. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- grafana-create-annotation
- Version
- 0.0.3
- App
- Grafana
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗