Skip to main content
Glama

Check a JSON object field contract

bpj_check_object_field_contract
Read-onlyIdempotent

Compare one sample object with a field-to-type map and report missing, additional, and mistyped top-level fields.

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": {
      "contract": "<contract>",
      "sample": "<sample>"
    },
    "name": "bpj_check_object_field_contract"
  }
}

Input Schema

NameRequiredDescriptionDefault
sampleYes
contractYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered; the description adds the meaningful scope constraint that only top-level fields are checked, and that the sample is a single object rather than an array. It does not disclose how type matching is decided or what form the report takes, so it goes only modestly beyond the structured hints.

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?

A single front-loaded sentence with no filler; the scope qualifier and the three output categories are packed efficiently. It is arguably too terse for a tool with two undescribed parameters, but nothing in it is redundant.

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?

With no output schema and nothing in the schema descriptions, the description bears the burden of explaining both input encoding and result shape; it sketches the result categories but not the report structure or severity, and leaves contract format unspecified. Adequate to identify the tool, not sufficient to call it confidently without experimentation.

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 description coverage is 0%, so the description must carry meaning, and it does map both parameters conceptually ("sample object" and "field-to-type map") and pins the contract to a type map. It stops short of specifying the encoding of either string parameter (e.g., whether the contract is JSON like {"name":"string"}) or what a type name token should look like, leaving real ambiguity.

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?

Uses a specific verb ("Compare") against a named resource ("one sample object with a field-to-type map") and enumerates the three finding categories it produces. The task is unmistakable, though it does not name or distinguish itself from nearby siblings such as bpj_compare_json or bpj_check_json_lines.

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 purpose implies the usage context (validating a sample against an expected shape), but there is no explicit when-to-use, no prerequisites, and no statement of when a different tool would be the better choice. An agent must infer the selection between this and the other JSON comparison utilities.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.