Skip to main content
Glama

Compare API export signatures

bpj_release_api_symbol_change
Read-onlyIdempotent

Compare two symbol-to-signature manifests and list added, removed and changed public exports.

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": {
      "before": "<before>",
      "after": "<after>"
    },
    "name": "bpj_release_api_symbol_change"
  }
}

Input Schema

NameRequiredDescriptionDefault
afterYes
beforeYes

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?

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds the meaningful output shape (added, removed, changed exports), which goes beyond annotations, but says nothing about how the two manifests are parsed or what happens with malformed input.

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 well-formed sentence with the resource and the result categories front-loaded; nothing is wasted. It is arguably too terse rather than bloated, so it loses a point for under-specification rather than verbosity.

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 no parameter descriptions, the definition is complete enough for an agent to guess the call signature but not to construct valid manifest strings. The result categories are stated, but the input contract remains unexplained.

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 carries the burden, and it only tells us the parameters are two symbol-to-signature manifests, implying an earlier/later ordering. It gives no clue about the expected string format of a manifest, how signatures are matched, or the 6000-character limit's implications.

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 states a specific verb and resource: comparing two symbol-to-signature manifests and listing added, removed, and changed public exports. That clearly distinguishes it from generic siblings like bpj_compare_json or bpj_compare_line_sets, though it never names an alternative explicitly.

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?

Usage is only implied by the release/signature framing; the agent can infer this is for diffing API surface between two releases. There is no explicit statement of when to prefer this over bpj_release_package_exports or the other compare tools, and no prerequisites are given.

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.