# Create Annotation — Grafana

> 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…

- Key: `grafana-create-annotation`
- Type: Action (Write)
- Version: 0.0.3
- App: Grafana (`grafana`) — https://pipedream.com/apps/grafana.md
- This page (HTML): https://pipedream.com/apps/grafana/actions/create-annotation
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/grafana/actions/create-annotation/create-annotation.mjs

## Description

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).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `text` | `string` | Yes | Annotation text/description. |
| `dashboardUid` | `string` | No | Dashboard to annotate. Omit for a global annotation visible on all dashboards. Use Search Dashboards to find the UID. |
| `panelId` | `integer` | No | Specific panel within the dashboard to annotate. |
| `tags` | `string[]` | No | Tags for filtering annotations. |
| `time` | `integer` | No | Start time as epoch milliseconds. Default: now. |
| `timeEnd` | `integer` | No | End time as epoch milliseconds for range annotations. Omit for a point-in-time annotation. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/grafana.md · All apps: https://pipedream.com/apps