Skip to main content
Glama
benpalmer1

Gorgias MCP Server

by benpalmer1

Update Rule

gorgias_update_rule
Idempotent

Update a Gorgias rule by ID: toggle activation, adjust priority, or edit description without resending the entire rule.

Instructions

PUT /api/rules/{id} — Update a rule by ID. All body fields are optional; only the fields you supply will be modified. Common partial updates: toggle deactivated_datetime, bump priority, edit description without resending name+code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe unique ID of the rule to update
codeNoThe logic of the rule as JavaScript code
nameNoThe name of the rule
code_astNoThe logic of the rule as an ESTree AST representation (auto-generated from code if not specified)
priorityNoOrder of execution; rules with higher priority values are executed first
descriptionNoA human-readable description of the rule
event_typesNoComma-separated list of events that trigger this rule. Allowed values: ticket-created, ticket-updated, ticket-message-created, ticket-assigned, ticket-self-unsnoozed, satisfaction-survey-responded
deactivated_datetimeNoISO 8601 datetime when the rule was deactivated. Set to null to reactivate the rule
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, openWorldHint=true, idempotentHint=true), the description discloses the key partial-update behavior—only supplied fields are modified—and illustrates with practical examples. This adds informational value without contradicting 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences, front-loaded with the HTTP method and action. Every clause contributes: the action, the partial-update rule, and practical examples, with no superfluous wording.

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 moderately complex tool with 8 parameters and no output schema, the description captures the essential behavioral nuance of partial updates and provides enough context for correct use. It does not mention return values or error handling, but the schema and annotations cover the remaining details.

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 schema already provides thorough descriptions for all 8 parameters (100% coverage), so the baseline is 3. The description adds slight value by suggesting common parameter manipulations (bump priority, edit description) but does not deeply elaborate on individual parameter semantics beyond schema.

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 clearly states 'Update a rule by ID' with the HTTP method, making the action unambiguous. It distinguishes from sibling tools by focusing on a single rule with partial updates, rather than bulk operations like update_rules_priorities.

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?

The description provides clear context on when to use the tool, emphasizing partial updates: 'All body fields are optional; only the fields you supply will be modified' and giving common examples like toggling deactivated_datetime or editing description. However, it does not explicitly mention alternatives such as create_rule or update_rules_priorities, so the guidance is contextual rather than explicitly exclusive.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/benpalmer1/Gorgias-MCP-Server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server