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

ohneben's Wafeq MCP

by ohneben
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

wafeq_credit_notes_list

Read-onlyIdempotent

Retrieve credit notes filtered by branch, status, contact, project, or date range to review and reconcile financial records.

Instructions

🟢 READ-ONLY · Credit Notes · GET /credit-notes/

List credit notes

Endpoint for retrieving a list of credit notes.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "wafeq_credit_notes_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoA page number within the paginated result set.
branchNoThe unique identifier of the branch.
statusNoThe status of the credit note
contactNoThe unique identifier of the contact.
projectNoThe unique identifier of the project.
page_sizeNoNumber of results to return per page.
external_idNoExternal identifier
created_ts_afterNoThe timestamp in UTC when the credit note was created
credit_note_dateNoCredit note date
created_ts_beforeNoThe timestamp in UTC when the credit note was created
modified_ts_afterNoThe timestamp in UTC when the credit note was last modified
modified_ts_beforeNoThe timestamp in UTC when the credit note was last modified

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds minimal extra context: the HTTP method/path (GET /credit-notes/) and the redundant '🟢 READ-ONLY' label. It does not disclose pagination behavior, filtering semantics, or response shape, but with strong annotations the bar is lower and the endpoint detail earns a 3.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short and front-loaded with the READ-ONLY badge and endpoint, but 'List credit notes' and 'Endpoint for retrieving a list of credit notes' are redundant restatements of the same idea. A single crisp sentence would have been equally clear.

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?

For a 12-parameter list tool with comprehensive schema coverage and safety annotations, the description is adequate but thin. There's no output schema, so a note on return shape or pagination defaults would help, and nothing clarifies that all filters are optional. The openWorldHint also suggests unlisted capabilities that the description doesn't acknowledge.

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 100%, so every one of the 12 parameters is already documented in the input schema. The description adds zero parameter-level meaning, so the baseline of 3 applies.

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 uses a specific verb+resource pair ('List credit notes') and confirms it with the collection endpoint 'GET /credit-notes/'. The plural resource and 'list' verb clearly distinguish it from siblings like wafeq_credit_notes_retrieve, though it doesn't explicitly name them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to choose this tool over alternatives. The description merely states what the endpoint does ('Endpoint for retrieving a list of credit notes') without explaining scenarios, exclusions, or how it differs from retrieve/create/destroy siblings. Nothing is left to inference except the generic meaning of 'list'.

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