Skip to main content
Glama
Pabau MCP Server

Pabau MCP Server

pabau_read

Reads the current Pabau page to return its text and numbered buttons, links, and fields, optionally limited to one element for targeted inspection.

Instructions

Read the current Pabau page: its text and numbered buttons, links and fields.

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

Input Schema

NameRequiredDescriptionDefault
elementNoRead only inside this element.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does disclose the useful behavioral detail that buttons and fields come back numbered (the reference scheme for later clicks), but it says nothing about read-only safety, whether long pages are truncated, or how the numbering resets.

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

Conciseness5/5

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

One front-loaded sentence with the resource first and the return contents second; every clause carries information and nothing is padding.

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 one-optional-parameter, no-output-schema tool this is close, and the mention of numbered buttons is genuinely valuable. Still missing are the scoping behavior of the element parameter and any statement about output size limits, which matter for a page-reading tool.

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% and the single optional "element" parameter is documented there as "Read only inside this element." The description adds no meaning about scoping, so the schema 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?

"Read the current Pabau page" gives a specific verb and resource, and the colon clause enumerates what comes back (text, numbered buttons, links, fields). It is clearly distinguishable from pabau_click/pabau_type by the read verb, though it never names a sibling to contrast with.

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: an agent can infer this is the way to inspect the page before acting on it with pabau_click or pabau_type. There is no explicit when-to-use, no exclusion, and no mention of pabau_status or pabau_guide as alternatives.

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