Skip to main content
Glama

Search Pricebook Tool

search-pricebook
Read-only

Searches active customer-facing services and materials in the authenticated workspace without exposing internal cost or markup fields. Use to search pricebook in the connected business. Returns query, count, total, pricebook, filters, scope.

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": "search-pricebook"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNoService or material.
limitNoMaximum items to return.
queryNoPricebook item name or description.
activeNoFilter by active state; defaults to true.

Output Schema

NameRequiredDescriptionDefault
countYesCount for the returned result.
queryYesQuery used or returned by this tool.
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
totalYesTotal for the returned result.
filtersYesFilters metadata; empty collections retain their existing JSON array representation.
pricebookYesBounded pricebook records returned by this tool.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "count": {
      +      "description": "Count for the returned result.",
      +      "type": "integer"
      +    },
      +    "filters": {
      +      "description": "Filters metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "pricebook": {
      +      "description": "Bounded pricebook records returned by this tool.",
      +      "items": {
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "query": {
      +      "description": "Query used or returned by this tool.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    },
      +    "total": {
      +      "description": "Total for the returned result.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "count",
      +    "total",
      +    "pricebook",
      +    "filters",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and a closed-world scope, so the safety profile is covered. The description adds genuinely new behavioral context: only active, customer-facing items are searched and internal cost/markup fields are deliberately withheld from results, which matters for how an agent interprets gaps in the data.

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 scope and the exclusion of internal cost fields are front-loaded in the first sentence, which is the right ordering. The closing "Returns query, count, total, pricebook, filters, scope" is largely redundant given an output schema exists and is the one sentence that does not earn 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?

With an output schema present, the description does not need to enumerate return values, and it already covers resource scope and data-visibility limits. Remaining gaps are minor: no mention of result capping via limit/maximum 50 or of how the default active filter affects counts.

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 the meaning of type, limit, query and active is already fully documented, including the active-defaults-to-true behavior. The description adds no syntax or filtering nuance beyond that, so the baseline 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?

"Searches active customer-facing services and materials" gives a specific verb plus a clearly bounded resource, and naming pricebook distinguishes it from the other search-* siblings. It stops short of explicitly contrasting itself with any sibling, so it lands just below a 5.

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?

"Use to search pricebook in the connected business" restates the purpose rather than giving real guidance: no when-to-use conditions, no exclusions, no alternatives named. An agent knows what the tool does but gets no routing help beyond the resource name.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources