Skip to main content
Glama

List rulesets

list_rulebooks
Read-only

List the project's rulesets with their rules and, in attachedTo, the workflows and connections each one is attached to. A ruleset is a name and ordered rules; each rule is one statement at level must (a failure refuses the write) or should (a failure is reported). Rules run only inside workflow runs: a ruleset is checked when it is attached to a workflow connection (rulebookIds in update_workflow) and the write that completes that step happens.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesId of the Project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

The annotations already indicate readOnlyHint=true, so the description does not need to restate safety. It adds useful behavioral context: what a ruleset is, the two rule levels (must vs should) and their failure semantics, and the fact that rules only run inside workflow runs when attached to a workflow connection. These details go beyond the annotations.

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 description front-loads the main purpose in its first clause and then uses subsequent sentences to define rulesets, rule levels, and attachment behavior. It is appropriately sized for a list tool without an output schema, though the domain explanation could be slightly tighter.

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 does the work of explaining the return shape: rulesets contain ordered rules, and attachedTo shows workflows and connections. It also explains the meaning of rule levels. Pagination or ordering of the ruleset list itself is not addressed, but the core contextual needs are covered.

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?

The input schema has 100% description coverage for its single parameter, projectId. The description does not add any additional syntax, format, or filtering semantics for that parameter, so the schema already carries the full parameter explanation. This meets the baseline of 3 for high schema coverage.

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?

The description opens with a specific verb and resource ('List the project's rulesets') and immediately qualifies the returned content: rules and attachment relationships. It clearly distinguishes this from sibling CRUD tools like create_rulebook or update_rulebook by specifying that this is a read operation listing rulesets with their rules and attachments.

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?

The description explains the domain context of rulesets and when rules execute, but it does not explicitly state when an agent should call this tool versus alternatives such as get_workflow or check_rules. Usage is implied by the list operation, but no direct when-to-use or when-not-to-use guidance is provided.

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