Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Notes

Notes let you and your team add context to error groups. They are useful for tracking investigation status, recording decisions, and leaving a trail for teammates.

MCP supports listing, adding, and deleting notes on error groups.

List Notes

Tool: list_notes_tool Scope required: telebugs.read

Retrieve notes attached to a specific error group, newest first.

Parameters

ParameterTypeRequiredDefault
group_idintegerYes-
limitintegerNo50 (max 100)

Example Response

{
  "notes": [
    {
      "id": 7,
      "content": "Investigating - looks like a race condition in checkout.",
      "created_at": "2026-05-20T15:30:00Z",
      "automated": false,
      "user": {
        "id": 1,
        "name": "Kyrylo",
        "email_address": "[email protected]"
      }
    },
    {
      "id": 12,
      "content": "Auto-resolved: No reports in the last 30 days.",
      "created_at": "2026-06-10T08:15:00Z",
      "automated": true,
      "user": null
    }
  ]
}

Notes created by users have automated: false and include user information. System-generated notes have automated: true.

Add Note

Tool: add_note_tool Scope required: telebugs.write

Add a note to an error group.

Parameters

ParameterTypeRequired
group_idintegerYes
notestringYes

Example Response

{
  "note_id": 8,
  "group_id": 42
}

Delete Note

Tool: delete_note_tool Scope required: telebugs.write

Remove a note you can access.

Parameters

ParameterTypeRequired
note_idintegerYes

Example Response

{
  "deleted": true,
  "note_id": 8
}

Common Use Cases

  • Record investigation progress (“Investigating suspected memory leak”)
  • Document root cause and fix (“Fixed by PR #847 in v1.4.2”)
  • Add context for teammates (“This only happens on weekends”)
  • Let AI tools leave notes when they take action on an error group

Error Responses

See Errors for general handling.

Common errors for this resource:

MessageCause
Group not found or access deniedInvalid group_id or insufficient permissions
Note cannot be blankEmpty note content provided
Note not found or access deniedInvalid note_id or insufficient permissions
Insufficient scope. Required: telebugs.writeOAuth token lacks write scope