qgroundcontrol mavlink-includes.instructions.md

Code-review rules for C++ headers in a MAVLink-based Qt project. MAVLink is a communication protocol often used by drones and other vehicles.

In plain words
What is it for?
Checking MAVLink includes during reviews and choosing lighter headers or forward declarations when possible.
Why use it?
They help prevent headers from loading far more code than necessary, which can make Qt's code-processing tool much slower.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/mavlink/qgroundcontrol/mavlink-includes
Clone the repo
git clone --depth 1 https://github.com/mavlink/qgroundcontrol

Made for: GitHub Copilot.

Per session 615 This file is loaded in full into every session.
When invoked 615 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00615 $0.00615
Opus 5 $0.00308 $0.00308
Sonnet 5 $0.00123 $0.00123
Haiku 4.5 $0.00061 $0.00061

Measured 2d ago against content hash 9a217119bff7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

qgroundcontrol mavlink-includes.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/mavlink-includes.instructions.md · 36 lines

How it starts

The opening of the file, as written. The whole thing — 36 lines — stays where its author put it; the contents beside it link to each section on GitHub.

C++ header files must use the lightest possible MAVLink include. Heavy includes in headers slow Qt moc parsing dramatically (~2.5s vs ~8ms per header).

Include Hierarchy (lightest to heaviest)

Header Provides Preprocessed Lines
MAVLinkEnums.h All 253 MAVLink enum typedefs (MAV_CMD, MAV_TYPE, MAV_RESULT, etc.) ~5,500
MAVLinkMessageType.h mavlink_message_t, mavlink_channel_t, base types ~2,700
QGCMAVLinkTypes.h FirmwareClass_t, VehicleClass_t, maxRcChannels ~50
VehicleTypes.h MavCmdResultFailureCode_t, RequestMessageResultHandlerFailureCode_t ~30
QGCMAVLink.h All of the above combined ~8,300
MAVLinkLib.h Full MAVLink with all 387 message pack/unpack headers ~180,000

Rules

  1. Never include MAVLinkLib.h in a .h file unless the header uses specific MAVLink message struct types in its declarations (e.g., mavlink_command_long_t, mavlink_command_ack_t). Move message struct usage to .cc files when possible.

  2. Never include Vehicle.h just for type aliases. Use VehicleTypes.h + class Vehicle; forward declaration instead, when only MavCmdResultFailureCode_t or RequestMessageResultHandlerFailureCode_t are needed.

  3. Pick the lightest include that satisfies the header's needs:

    • Only enum constants? → MAVLinkEnums.h
    • mavlink_message_t in signatures? → MAVLinkMessageType.h
    • Both enums and message type? → MAVLinkEnums.h + MAVLinkMessageType.h (still lighter than QGCMAVLink.h)
    • FirmwareClass_t / VehicleClass_t? → QGCMAVLinkTypes.h
  4. Headers must be self-contained. Every type used in a header's declarations must be provided by an explicit #include, not by the precompiled header (PCH). The PCH provides MAVLinkLib.h for .cc files, but moc processes headers independently.

  5. MAVLinkLib.h is fine in .cc files — it's provided by the PCH anyway. Only header includes affect moc parse time.

Read the full file on GitHub · 36 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 36 lines · 615 tokens per session scan A 9a217119bff7

Subscribe to this mod's changes

qgroundcontrol mavlink-includes.instructions.md is an instructions file published in the GitHub repository mavlink/qgroundcontrol (4,888 stars, last pushed today), licensed Apache-2.0. It adds 615 tokens to every session, about $0.0031 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.