Skip to main content
Glama

Add a playbook rule

add_playbook_rule

Add a rule to a product's playbook, the approved guidance its AI agent follows. Admins only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesThe rule, up to 12,000 characters.
productIdYesProduct id from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare this is a write operation that is non-destructive, non-idempotent, and closed-world. The description adds one meaningful behavioral detail beyond annotations: the admin-only authorization requirement. It does not address the implications of non-idempotency (e.g., creating duplicate rules) or describe the response.

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?

A single, front-loaded sentence with zero waste. It defines the resource, explains the domain term 'playbook', and states the key access constraint all in one pass.

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 simple two-parameter write tool with full schema coverage and annotations covering the safety profile, the description supplies enough context to call it correctly: purpose, admin restriction, and playbook definition. The main remaining gap is that it does not route the agent to 'update_playbook_rule' when modifying an existing rule.

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 both parameters are already well documented by the schema. The description adds no additional syntax, format, or constraint details for 'productId' or 'content' beyond what the schema provides.

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 states a specific verb ('Add') and resource ('rule to a product's playbook') and even defines what a playbook is. It does not explicitly name the sibling 'update_playbook_rule' or otherwise differentiate itself from it, so it falls short of the top score.

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?

It gives a prerequisite ('Admins only') but does not say when to use this tool versus alternatives such as update_playbook_rule, nor does it provide any when-not-to-use guidance. Usage is implied by the tool name and purpose, not explicitly guided.

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