Skip to main content
Glama

Read Rule

pathrule_read_rule
Read-only

Read the full body and metadata for one Pathrule rule. Use this after pathrule_get_context, pathrule_goto, or pathrule_get_node returns a rule_id. Rules are instructions the AI should obey for a project path; this tool only reads the cloud rule record and does not modify anything.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_idYesRule UUID returned by pathrule_get_context, pathrule_goto, or pathrule_get_node.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoRule UUID.
okYestrue when the call succeeded. false when it did not, in which case `error` carries the reason and the success fields are absent.
nameNoRule name.
errorNoPresent only when ok is false.
contentNoFull rule body: the constraint to obey.
priorityNoOne of high, medium, or low.
node_pathNoWorkspace-relative path the rule applies to.
scope_typeNoOne of project, folder, or file_type.
updated_atNoLast update timestamp in ISO 8601.
version_idNoOptimistic-concurrency token. Pass it as expected_version_id to pathrule_update_rule.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "content": {
      +      "description": "Full rule body: the constraint to obey.",
      +      "type": "string"
      +    },
      +    "error": {
      +      "additionalProperties": true,
      +      "description": "Present only when ok is false.",
      +      "properties": {
      +        "code": {
      +          "description": "Stable machine-readable failure code, for example insufficient_scope, workspace_id_required, rate_limited, not_found, or upstream_error. Branch on this, not on message text.",
      +          "type": "string"
      +        },
      +        "detail": {
      +          "description": "Optional structured context for the failure, for example { missing_scopes: [...] } on insufficient_scope."
      +        },
      +        "message": {
      +          "description": "Human-readable explanation of the failure.",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "code",
      +        "message"
      +      ],
      +      "type": "object"
      +    },
      +    "id": {
      +      "description": "Rule UUID.",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "Rule name.",
      +      "type": "string"
      +    },
      +    "node_path": {
      +      "description": "Workspace-relative path the rule applies to.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "ok": {
      +      "description": "true when the call succeeded. false when it did not, in which case `error` carries the reason and the success fields are absent.",
      +      "type": "boolean"
      +    },
      +    "priority": {
      +      "description": "One of high, medium, or low.",
      +      "type": "string"
      +    },
      +    "scope_type": {
      +      "description": "One of project, folder, or file_type.",
      +      "type": "string"
      +    },
      +    "updated_at": {
      +      "description": "Last update timestamp in ISO 8601.",
      +      "type": "string"
      +    },
      +    "version_id": {
      +      "description": "Optimistic-concurrency token. Pass it as expected_version_id to pathrule_update_rule.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ok"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Consistent with readOnlyHint=true and destructiveHint=false. The description adds useful context beyond annotations: rules are AI instructions for a project path, and the tool reads the cloud rule record. This helps distinguish it from local-runtime or memory-related reads.

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?

Three tight sentences: purpose first, usage trigger second, domain context and non-mutating behavior third. Every sentence earns its place and there is no filler.

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?

For a one-parameter read tool with a full input schema, output schema, and safety annotations, the description covers purpose, when to call, what it returns, and that it is non-destructive. Nothing essential is missing.

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 single parameter rule_id is fully documented in the input schema, including its UUID format and which sibling tools return it. The description reinforces this provenance but adds no new parameter semantics, so the baseline of 3 applies.

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?

States a specific verb and resource: 'Read the full body and metadata for one Pathrule rule.' It clearly distinguishes this from write/update/delete siblings by emphasizing that it only reads the cloud rule record and does not modify anything.

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?

Gives explicit guidance: 'Use this after pathrule_get_context, pathrule_goto, or pathrule_get_node returns a rule_id.' This tells the agent exactly when to invoke it. It doesn't explicitly name alternatives for modifying rules, but 'does not modify anything' implies the boundary.

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.

TDQS

A3.8/5.0
Disambiguation4/5

Tools are grouped by resource (memory/rule/skill/workspace/snapshot/refresh) and mostly have distinct output shapes, so agents can usually pick the right one. A few retrieval tools (get_context, get_node, get_tree, goto) overlap in purpose, but their descriptions clarify resolution mode vs full tree vs context bundle.

Naming Consistency3/5

All tools share the pathrule_ prefix and mostly follow verb_noun, but the verbs are inconsistent: create_workspace vs write_memory, get_node vs read_memory, delete_skill vs remove_pattern, plus verb-only exceptions like goto, setup, and ping. The pattern is readable but not uniform.

Tool Count2/5

32 tools is above the 25-tool threshold and feels heavy for a single server, even with a broad domain. Several context-retrieval tools and read/list variants could potentially be consolidated, though each tool does have a specific purpose.

Completeness4/5

Core CRUD is covered for memories, rules, and skills, along with workspaces, snapshots, refresh tasks, and pattern import/removal. Minor gaps include no standalone list_rules/list_skills and no snapshot update/delete, but agents can work around these via get_context, goto, and get_tree.

Resources