Skip to main content
Glama
Sign In
ohneben's Wafeq MCP

ohneben's Wafeq MCP

by ohneben
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

wafeq_debit_notes_download_retrieve

Read-onlyIdempotent

Download a debit note as a PDF by providing its ID. Retrieves base64-encoded PDF bytes with size and content type without modifying data.

Instructions

🟢 READ-ONLY · returns a PDF · Debit Notes · GET /debit-notes/{id}/download/

Download debit note PDF

Endpoint for downloading a PDF of the debit note.

Returns the document as base64-encoded PDF bytes plus its size and content type. Nothing is modified.

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": "wafeq_debit_notes_download_retrieve"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, and non-destructive behavior, so the description adds value by describing the response shape: base64-encoded PDF bytes, size, and content type. The explicit statement 'Nothing is modified' reinforces the safe profile without contradicting the annotations.

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 description is compact and front-loaded with the READ-ONLY label, resource, HTTP method, and endpoint. There is minor redundancy between 'Download debit note PDF' and 'Endpoint for downloading a PDF of the debit note,' but the extra return-value detail earns its place.

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?

For a simple single-parameter, read-only download endpoint, the description is sufficiently complete: it names the resource, the endpoint, the required identifier, and the return format. No output schema exists, so the explicit description of base64-encoded PDF bytes plus size and content type is valuable. Error conditions and id-format details are absent but not critical here.

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%, and the description does not directly document the `id` parameter. However, the endpoint path '/debit-notes/{id}/download/' makes clear that `id` identifies the debit note to download, adding some meaning beyond the bare schema. With only one required parameter, this is adequate, though format and source of the id are not explained.

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?

The description states a specific action ('Download debit note PDF'), names the resource ('Debit Notes'), and gives the exact endpoint GET /debit-notes/{id}/download/. This clearly separates it from sibling download tools for invoices, bills, payslips, and other documents.

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 clearly establishes that this tool is for downloading a PDF of a debit note, which is the key context an agent needs to select it over wafeq_debit_notes_retrieve or other document endpoints. It does not explicitly name alternatives or state when not to use it, but the download purpose is unambiguous and no exclusions are needed.

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