Skip to main content
Glama
Sign In
gapify-mcp-server

gapify-mcp-server

by mh-zeynal
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Automation Rule: Get a automation rule details

gapify_get_automation_rule
Read-onlyIdempotent

Retrieve an automation rule by ID for a Gapify account to inspect its settings, conditions, and actions.

Instructions

Get an automation rule by ID [Automation Rule] GET /api/v1/accounts/{account_id}/automation_rules/{id} Auth: User API key (header api-access-token). Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "account_id": "<account_id>",
      "id": "<id>"
    },
    "name": "gapify_get_automation_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe ID of the automation rule to be updated.
account_idYesThe numeric ID of the account

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful non-schema context: the required User API key header (`api-access-token`) and the locale/numeral convention (Persian/Arabic-Indic digits accepted, text passed through unchanged). It omits behavior for a missing/invalid rule ID, which keeps it from a 5.

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 purpose is front-loaded in the first clause, and the endpoint, auth and encoding details are compact single lines. The API path and encoding boilerplate are somewhat mechanical, but nothing is redundant enough to penalize heavily.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 should ideally convey what a returned automation rule contains or the failure mode for an unknown ID; instead it stops at endpoint, auth and encoding. For a simple two-parameter read it is adequate but not complete.

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 the baseline is 3 and the schema documents both account_id and id. The description adds only the numeral-format note (Persian/Arabic-Indic digits allowed) for IDs; notably it does not correct the schema's misleading id description, which says 'the automation rule to be updated' on a read tool.

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 ('Get an automation rule by ID') and even gives the underlying endpoint path, so the operation is unambiguous. It does not, however, explicitly distinguish itself from the sibling list/add/update/remove automation rule tools, so it stops short of a 5.

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 'by ID' framing implies this is the lookup tool for a single known rule, but there is no explicit guidance on when to use it versus gapify_list_automation_rules or gapify_update_automation_rule. Usage is inferable from the name rather than stated.

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