Skip to main content
Glama
jgstew

bigfix-root-mcp

by jgstew

Api Get

api_get

Retrieve any read-only BigFix REST API path under /api/ to inspect endpoints and data without mutations. Use 'help' to discover available endpoints.

Instructions

Read-only escape hatch: GET any BigFix REST API path under /api/.

GET is non-mutating across the BigFix REST API. Use path 'help' to discover available endpoints. Response text is capped at max_chars; total_chars reports the full length.

Input Schema

NameRequiredDescriptionDefault
pathYesRelative REST API path under /api/, e.g. 'help', 'computers', 'sites', 'computer/123'. Query strings allowed.
max_charsNoMax characters of response text (default 50000).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • addedInput schema / properties / max_chars
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Max characters of response text (default 50000)."
      +}
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the safety profile itself and does so clearly by stating GET is non-mutating across the BigFix REST API. It also discloses response truncation via max_chars and total_chars, though it omits auth, rate-limit, and error behavior.

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

Conciseness5/5

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

The description is short, front-loaded with the core purpose, and every sentence adds operational value. There is no redundant restatement of the tool name or schema.

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

Completeness4/5

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

For a generic REST escape hatch with an output schema, it covers purpose, safety, discovery, and truncation adequately. It is slightly thin on endpoint-dependent auth and error semantics, but the output schema reduces the need to describe return values.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds useful meaning by explaining that max_chars caps response text and total_chars reports full length. The path parameter's relative /api/ format and examples are already well covered by the schema.

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

Purpose5/5

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

The description states a specific verb and resource: GET any BigFix REST API path under /api/. The phrase "read-only escape hatch" clearly frames it as a generic fallback relative to the many dedicated sibling tools.

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

Usage Guidelines4/5

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

It establishes the tool as an escape hatch and recommends path 'help' for discovering endpoints. However, it does not explicitly say when to prefer the many purpose-built sibling tools or when not to use this generic endpoint.

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