Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Get Ppsr Search

get_ppsr_search
Read-only

Retrieves the status and results of an existing PPSR search, including registrations, NEVDIS data, and certificates, so you can monitor processing and access completed search outcomes.

Instructions

Get the status / results of a PPSR search created with create_ppsr_search. status: new -> processing -> completed | failed. Results are under data (registrations[], nevdisData, certificates[]). Certificate PDFs: GET /ppsr/searches/{requestId}/certificates/{certificateNumber} (returns 202 while still generating).

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": {
      "request_id": "<request_id>"
    },
    "name": "get_ppsr_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so safety is covered. The description adds genuinely useful behavior beyond that: the asynchronous status lifecycle, that results live under `data` with registrations[], nevdisData and certificates[], and that certificate PDFs return 202 while still generating. It does not contradict the read-only 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?

Front-loaded with purpose, then status semantics, then result shape and the certificate sub-resource caveat. Every sentence carries information, though the raw HTTP endpoint notation is slightly implementation-flavored for an agent-facing description.

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?

An output schema exists, so return-value documentation isn't strictly required, yet the description usefully sketches the `data` payload and the asynchronous completion caveat for certificates. What's missing is minor: guidance on polling cadence or what to do when status is 'failed'.

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?

There is one parameter with 0% schema description coverage, so the schema gives no semantic help. The description only indirectly conveys that request_id identifies a search created by create_ppsr_search, mostly through the certificate URL path showing {requestId}; it never explicitly maps request_id to that returned identifier or states its type/format.

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?

States a specific verb and resource ('Get the status / results of a PPSR search') and anchors it to the sibling that creates the resource, create_ppsr_search. An agent can distinguish this retrieval tool from the creation tool without opening either schema.

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?

The description implies the correct usage pattern: call this after create_ppsr_search to poll status (new -> processing -> completed | failed) and retrieve results. It doesn't explicitly say to poll rather than call once, or what to do on failure, but the lifecycle sequence makes the intended context clear.

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