---
title: Instructions for AI agents
description: Machine-generated reference documents that teach LLMs and AI agents how to query, visualize, and manage Honeybadger data.
url: https://docs.honeybadger.io/resources/llms/instructions/
---

These are reference documents written for LLMs and AI agents rather than people. They teach an agent how to work with Honeybadger correctly: writing BadgerQL, configuring visualizations and dashboards, managing alarms, and searching errors.

If you are building on Honeybadger with an AI assistant, coding agent, or your own tooling, fetch the relevant instructions and include them as context. The [Honeybadger MCP server](https://docs.honeybadger.io/resources/mcp/) serves this same content to connected agents.

## Available instructions

| Name                                                                              | Covers                                                                                                                                           | Size           |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
| [badgerql](https://docs.honeybadger.io/resources/llms/instructions/badgerql/)     | The BadgerQL language: grammar, type hints, built-in fields, statements, expression functions, and the rules for writing correct queries.        | \~7,593 tokens |
| [queries](https://docs.honeybadger.io/resources/llms/instructions/queries/)       | Fundamentals for querying Honeybadger Insights: streams, time ranges, event-class filtering, and verifying field names exist before aggregating. | \~1,524 tokens |
| [charts](https://docs.honeybadger.io/resources/llms/instructions/charts/)         | Visualization views for Insights query results and the chart\_config fields each view accepts.                                                   | \~1,644 tokens |
| [dashboards](https://docs.honeybadger.io/resources/llms/instructions/dashboards/) | Insights dashboard structure: the dashboard object, widget types and their configs, grid layout, and the vis object.                             | \~1,220 tokens |
| [alarms](https://docs.honeybadger.io/resources/llms/instructions/alarms/)         | Insights alarms: alarm fields, trigger\_config, states, evaluation timing, and query guidelines.                                                 | \~998 tokens   |
| [errors](https://docs.honeybadger.io/resources/llms/instructions/errors/)         | The Honeybadger error model (faults and notices), lifecycle states, and the error search query language.                                         | \~2,232 tokens |

## Fetching them

Each document is available in three forms:

* **Raw text** at `/resources/llms/instructions/<name>.txt`. This is the document byte-for-byte, with no page formatting. Use this form when injecting instructions into an agent’s context.
* **A readable page** at `/resources/llms/instructions/<name>/` (linked from the table above), with a markdown version at `/resources/llms/instructions/<name>.md` like every page on this site.
* **A machine-readable catalog** at [/resources/llms/instructions/index.json](https://docs.honeybadger.io/resources/llms/instructions/index.json), listing every document with its description, approximate token count, SHA-256 digest, and URL. Tools can read the catalog to discover what’s available without hardcoding the list, and use the digest to skip re-downloading unchanged content.

---

## Try Honeybadger for FREE

Intelligent logging, error tracking, and Just Enough APM™ in one dev-friendly platform. Find and fix problems before users notice.

[Start free trial](https://app.honeybadger.io/users/sign_up)

[See plans and pricing](https://www.honeybadger.io/plans/)