Skip to main content
Glama

Create ruleset

create_rulebook

Create a ruleset with a name and optionally its rules. Write each rule as one narrow statement the record either meets or not. 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
nameYesRuleset name.
rulesNoRules to create with the Ruleset, in order.
projectIdYesId of the Project.
requestIdNoOptional unique ID for this create. After a timeout, retry with the same requestId and arguments: the record already created is returned instead of a duplicate.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations only cover the safety profile (readOnlyHint=false, destructiveHint=false); the description goes further by disclosing that rules are evaluated only inside workflow runs and only against the write that completes an attached step. It still omits permission requirements and name-uniqueness behavior, but adds real behavioral context 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?

Three sentences, front-loaded with the core action, with no filler. The rule-writing sentence partially restates schema guidance, but it is short and framed as authoring advice rather than repetition.

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 create tool with no output schema and full schema coverage, the description supplies the missing operational context: where rulesets run and what triggers a check. Return values and auth requirements are not covered, but nothing critical to invoking it correctly is absent.

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%, so the schema already documents all four parameters including the must/should level semantics and the requestId idempotency retry. The description reinforces the intended shape of a rule ('one narrow statement the record either meets or not') but adds no syntax or format detail the schema lacks.

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?

States a specific verb and resource ('Create a ruleset with a name and optionally its rules'), and clarifies the scope of the nested rules. It does not explicitly distinguish itself from the sibling create_rule, so an agent must infer the boundary between creating a ruleset and creating an individual rule.

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 operational context ('Rules run only inside workflow runs') and how a ruleset becomes active (attached via rulebookIds in update_workflow), which implies when it matters. It never states when to prefer create_rulebook over create_rule or list_rulebooks, so the routing guidance is only implied.

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