Skip to main content
Glama
NetBox MCP Server

NetBox MCP Server

Official
by netboxlabs

netbox_get_changelogs

Read-only

Retrieve NetBox object change records (changelogs) using filters to track modifications and audit configuration history.

Instructions

Get object change records (changelogs) from NetBox based on filters.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "filters": "<filters>"
    },
    "name": "netbox_get_changelogs"
  }
}

Input Schema

NameRequiredDescriptionDefault
filtersYesdict of filters to apply to the API call based on the NetBox API filtering options

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The readOnlyHint annotation already establishes that this is a safe read, so the description owes additional context: whether results are paginated, how far back changelogs are retained, and what a change record contains. None of that is present, so the description adds essentially nothing beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence, front-loaded with the resource and free of padding. Its brevity is efficient rather than bloated, though the same single sentence carries no elaboration to reward a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a nested, free-form filter object with no enums and no output schema, an agent needs to know which filter keys are meaningful and what comes back. The description supplies neither, leaving the caller to guess at NetBox changelog filter semantics.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single 'filters' parameter is documented as a dict of NetBox API filtering options. The description only repeats 'based on filters' without naming valid keys (e.g. object type, object id, time range), so the schema is doing all the work and the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ('Get object change records (changelogs)') plus the scoping mechanism ('based on filters'), which is enough to distinguish it from the sibling tools that fetch objects, a single object, or search. It stops short of explicitly contrasting with those siblings, so a 4 rather than a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus netbox_get_objects or netbox_search_objects, and no exclusions or prerequisites. The phrase 'based on filters' is part of the purpose statement rather than usable routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.