Skip to main content
Glama
Sign In

editalmd

by com.editalmd
OverviewDiscussionsAdmin

Document reading manifest

get_reading_manifest
Read-onlyIdempotent

The document manifest: pages, images, SHA-256 and version. Send acesso_codigo; the examples are free. It does not start OCR. The same authorization opens the ZIP and the images through the API. Only ready resources. document_approved: false marks the automatic extraction and does not block reading.

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": {
      "id": "<id>"
    },
    "name": "get_reading_manifest"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument id.
agent_passNoIndividual agent credential, required together with X-Editalmd-Avaliacao.
acesso_codigoNoAuthorizes this document for whoever holds it. A purchase made with the account session issues no code: the global right of the account (HttpOnly cookie) applies, and the right of the guest edm_… applies with its token. A public receipt grants no access.
avaliacao_codigoNoevaluation.access_code of the sponsored premium, only for this document and agent, with an expiry. Use it together with X-Agent-Pass; it is not a receipt or a purchase.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / acesso_codigo / description
      Previous value: -"Authorizes this document for whoever holds it. A public receipt grants no access."New value: +"Authorizes this document for whoever holds it. A purchase made with the account session issues no code: the global right of the account (HttpOnly cookie) applies, and the right of the guest edm_… applies with its token. A public receipt grants no access."
    • changedInput schema / properties / avaliacao_codigo / description
      Previous value: -"evaluation.access_code of the sponsored premium, only for this document and agent, with an expiry."New value: +"evaluation.access_code of the sponsored premium, only for this document and agent, with an expiry. Use it together with X-Agent-Pass; it is not a receipt or a purchase."
  2. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already cover the safe-read profile (readOnly, idempotent, non-destructive). The description adds genuine value beyond them: 'It does not start OCR' discloses a non-side-effect, 'The same authorization opens the ZIP and the images' explains auth reuse, and the `document_approved: false` note clarifies a field's meaning so it doesn't mislead.

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?

The return contents are front-loaded and each sentence carries distinct information. Phrasing is choppy and slightly cryptic ('the examples are free'), but no sentence is clearly wasteful.

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?

With no output schema, the description compensates by enumerating the return fields (pages, images, SHA-256, version) and covering auth plus the 'only ready resources' constraint. Reasonably complete for a read tool, though sibling differentiation remains thin.

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 coverage is 100% and the schema descriptions for acesso_codigo and avaliacao_codigo are already detailed. The description adds only marginal meaning ('the examples are free', authorization reuse), so the schema carries most of the burden – 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 names the specific resource (document manifest) and enumerates its contents: pages, images, SHA-256 and version. This is clear enough to distinguish it from generic reads like get_document, but it never explicitly contrasts itself with close siblings such as list_document_files or get_document_dossier.

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?

It provides partial context: 'Send acesso_codigo; the examples are free' and 'Only ready resources' tell the agent how to authorize and a precondition. However, there is no explicit when-to-use-vs-alternatives guidance against the many sibling read tools, leaving routing largely to inference.

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

All editalmd toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources