Skip to main content
Glama

accelo_list_contract_periods

List billing intervals for a specific contract, including budget, allowance type, and rate details.

Instructions

List contract periods for a specific contract.

Contract periods are billing intervals within a contract (retainer). Each has a budget, allowance type, and rate. To find the company: period → contract_id → get contract → against_id (company_id).

Args: contract_id: Contract ID (required) — the parent contract filters: Filter dict. Keys: id, standing, budget_type, allowance_type, rate_type, rate, service_item, duration_type, rollover, contract_budget, date_created/commenced/expires/closed_before/after, order_by_asc/desc (id, date_created, date_commenced, date_expires, date_closed) fields: Additional fields, e.g. "contract_budget(),rate()" page: Page number (0-indexed) limit: Results per page (max 100)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
limitNo
fieldsNo
filtersNo
contract_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/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 correctly implies a read-only list and discloses pagination limits (max 100, 0-indexed pages), but says nothing about permissions, ordering defaults, or how closed/reopened periods affect results, leaving the mutation-adjacent siblings (close/reopen_contract_period) as the only signal of state.

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 purpose then domain model then Args, which is well ordered. The Args block is somewhat long and partially restates schema fields, but nearly every line (filter keys, order_by values, field syntax) adds information the schema lacks.

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 filtered list tool with no output schema, the definition covers the entity model, the hierarchy path to related objects, filtering, sparse field selection, and pagination. It stops short of describing the shape of a returned period, which is the main remaining gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate, and it largely does: it documents all five parameters and enumerates filter keys plus valid order_by fields. It still omits value types or accepted enum values for those filter keys, so it is not fully self-sufficient.

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?

States a specific verb and resource (list contract periods) scoped to a specific parent contract, and its domain gloss ('billing intervals within a contract (retainer)') makes it unambiguous against siblings like accelo_get_contract_period, accelo_list_contracts, and accelo_create_contract.

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?

Provides clear context for when this is the right call (you have a contract and need its billing periods) plus a navigation hint from period through contract_id to against_id. It never names an alternative or an explicit when-not condition, so it falls short of a 5.

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