Skip to main content
Glama

YESbusiness

Alerts

list_alerts
Read-onlyIdempotent

The announcements YESbusiness addressed to the user that they have not yet read or dealt with (newest first, 20 at most): the congratulations when an accounting is created, a notice the team sent, a step still to take. They belong to the USER, not to one company. Each has a heading, a body (prose in the user's language, may hold line breaks and '- ' bullets), an optional in-app link and a kind. Call it when the user asks whether anything needs their attention or what YESbusiness told them; you cannot dismiss one — the user does, on the dashboard.

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": {
      "company_id": "<company_id>"
    },
    "name": "list_alerts"
  }
}

Input Schema

NameRequiredDescriptionDefault
company_idYesThe company to work on — one of list_my_companies' company_id values.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered; the description nonetheless adds real value with the 20-item cap, newest-first ordering, user-level (not company-level) ownership, and the returned fields including body formatting and optional link. The only shortfall is that it does not say what happens when more than 20 alerts exist (truncation vs. pagination), which an agent calling with a hard cap needs to know to report accurately.

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?

Front-loads what the resource is and its bounds before the trigger condition and the dismissal caveat, which is the right order for an agent skimming. It is denser than strictly necessary — the three illustrative alert types and the detailed body-format aside could be trimmed — but every sentence carries information rather than restating the name.

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 correctly takes on the return-shape burden by describing heading, body, link and kind, which is enough for an agent to present alerts sensibly. The unresolved gaps are what the 'kind' values can be and why a required company_id exists for user-scoped data — minor but not trivial for a single-parameter 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 coverage is 100% and the schema already explains company_id by reference to list_my_companies, so the baseline is 3. The description adds no syntax or format detail for the parameter, and its claim that alerts 'belong to the USER, not to one company' sits in mild tension with the required company_id, leaving the agent to infer why a company scope is needed for user-level data.

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?

Names a specific resource (the user's unread/unaddressed YESbusiness announcements) and immediately bounds it with ordering and volume (newest first, 20 at most), plus concrete examples of what an alert is (congratulation on accounting creation, team notice, outstanding step). No sibling tool covers alerts, so ambiguity with export_report or list_bookings is nil.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('when the user asks whether anything needs their attention or what YESbusiness told them') and an explicit capability boundary ('you cannot dismiss one — the user does, on the dashboard'), which prevents an agent from promising or attempting a write. That negative guidance is exactly what distinguishes a usable listing tool from a frustrating one.

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