Skip to main content
Glama
Sign In
jq-mcp

jq-mcp

by kolodny
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

jq

Run jq filter expressions on JSON files from allowed directories. Specify file path and query to extract or transform data.

Instructions

Runs a jq query against a JSON file, gated by an allowlist of directories.

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": {
      "file": "<file>",
      "query": "<query>"
    },
    "name": "jq"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileYesPath to the JSON file (absolute, or resolved against cwd).
queryYesA jq filter expression.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.1

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the allowlist gating, which is important behavioral context. However, it omits details about error handling, return format, or read-only nature.

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 a single sentence that efficiently conveys the core function and the key constraint. Every word serves a purpose, with no redundancy.

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

Completeness3/5

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

For a simple two-parameter tool, the description covers purpose and a constraint. However, it lacks any mention of return values or behavior in failure cases, which would be expected given no output schema.

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?

The input schema provides full descriptions for both parameters (file path and query). The tool description adds no extra meaning beyond the schema; thus, baseline 3 is appropriate.

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 clearly states it runs a jq query on a JSON file, with a specific constraint (allowlist). The verb 'runs' and resource 'jq query against a JSON file' are precise. No sibling tools exist to differentiate, so 4 is appropriate.

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

Usage Guidelines3/5

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

The description implies usage through its function but does not explicitly state when to use or avoid this tool. The 'gated by allowlist' gives a condition, but no alternatives or prerequisites are mentioned.

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

Deploy Server

Other Tools