Skip to main content
Glama

sockdock_get_rule

Read-only

Retrieve a rule's complete settings—channel, trigger, permissions, actions, and limits—before editing it, so you preserve the user's configuration.

Instructions

Returns every setting of one rule: channel, condition, who may run it (allowed_users), what runs, and for an agent its instructions, permissions (web, file edits, allowed commands), model and time limit; for a program its path and arguments. Use it before changing a rule with sockdock_save_rule, so you keep what the user set. Give the rule's name from sockdock_list_rules.

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": {
      "name": "<name>"
    },
    "name": "sockdock_get_rule"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesthe rule's name (from sockdock_list_rules)

Output Schema

NameRequiredDescriptionDefault
nameYes
runsYes
modelNo
enabledYes
problemNowhy the rule cannot run, if it cannot
last_runNo
allow_webYes
conditionYes
allow_editYes
channel_idYes
prompt_fileNo
shadowed_byNoan earlier rule in the channel that always matches first, so this rule never runs
timeout_secNo0 means the default (600 for agents, 300 for programs)
channel_nameNo
instructionsNo
mention_onlyNotrue when the rule runs only for posts that mention the Slack app
allowed_usersNothe only people who may run the rule; absent means everyone in the channel (for a DM rule, everyone in the workspace). Posts and thread replies from anyone else are ignored without a reply
posts_arrivedNowhether a post from this channel has reached SockDock since it last connected; false only matters if someone has posted there since; left out when SockDock is not connected
allowed_commandsYesClaude Code only; a codex rule always lets Codex run commands in its sandbox (the working folder only, no network)
other_allowed_toolsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds the non-obvious behavioral point that this read is meant to precede a mutation to avoid clobbering user configuration. It does not discuss error behavior for a missing rule name, which is a minor gap.

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?

Purpose and scope are front-loaded, followed by usage guidance and parameter provenance. The long enumeration of returned fields is dense but justified because it defines what "every setting" means; minor redundancy with the output schema keeps it from a 5.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description needn't define return structure, yet it still sketches the payload enough to judge relevance. Combined with the pre-mutation guidance and the parameter source, an agent has everything needed to invoke this correctly.

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% and the single parameter's schema description already says "from sockdock_list_rules," so the description's matching sentence adds no new meaning beyond the schema. Baseline 3 applies when the schema fully carries parameter semantics.

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 ("Returns every setting of one rule") and then enumerates the returned settings—channel, condition, allowed_users, agent instructions/permissions/model/time limit, program path/arguments—so an agent knows exactly what this retrieves. It is clearly distinguishable from sibling list_rules and save_rule.

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?

It gives explicit workflow guidance: call this before sockdock_save_rule so the user's existing settings are preserved, and take the name from sockdock_list_rules. There are no exclusions (e.g., when list_rules or check_rule is sufficient instead), so it falls just short of a 5.

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