Skip to main content
Glama

Pathrule

by io.pathrule

Pathrule Read Project Snapshot

pathrule_read_snapshot
Read-only

Load a single project snapshot in full or partial form. Defaults include file_tree and sampled_contents — pass include_file_tree=false / include_sampled_contents=false to keep the response compact when you only need metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
snapshot_idYesSnapshot UUID from pathrule_list_snapshots.
workspace_idYesWorkspace UUID from pathrule_list_workspaces.
include_file_treeNoInclude the flat file/directory list. Defaults to true. Pass false to keep the response small.
include_sampled_contentsNoInclude the truncated bodies of the sampled files. Defaults to true. Pass false when you only need metadata.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYestrue when the call succeeded. false when it did not, in which case `error` carries the reason and the success fields are absent.
dataNoThe snapshot row. Which columns are present depends on include_file_tree and include_sampled_contents.
errorNoPresent only when ok is false.
human_messageNoOne-line summary of the result, safe to relay to the user verbatim.

Schema Changelog

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

  1. Changed5 schema fields changed
    • addedInput schema / properties / include_file_tree / description
      Added value: +"Include the flat file/directory list. Defaults to true. Pass false to keep the response small."
    • addedInput schema / properties / include_sampled_contents / description
      Added value: +"Include the truncated bodies of the sampled files. Defaults to true. Pass false when you only need metadata."
    • addedInput schema / properties / snapshot_id / description
      Added value: +"Snapshot UUID from pathrule_list_snapshots."
    • addedInput schema / properties / workspace_id / description
      Added value: +"Workspace UUID from pathrule_list_workspaces."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": true,
+  "properties": {
+    "data": {
+      "description": "The snapshot row. Which columns are present depends on include_file_tree and include_sampled_contents."
+    },
+    "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"
+    },
+    "human_message": {
+      "description": "One-line summary of the result, safe to relay to the user verbatim.",
+      "type": "string"
+    },
+    "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"
+    }
+  },
+  "required": [
+    "ok"
+  ],
+  "type": "object"
+}
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish that this is a safe, read-only operation, so the description's main job is to add behavioral context. It does that by revealing the default response includes file_tree and sampled_contents and by explaining how to opt out. This is genuinely useful beyond the annotation hints, though it doesn't cover pagination or error cases.

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 sentences with no filler. It front-loads the core behavior, then immediately gives the key flag defaults and the condition for changing them. Every sentence carries meaningful information.

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?

The tool is a straightforward read operation with an output schema and readOnlyHint annotation, so the description does not need to explain return values or safety. It covers the main usage decision—how to request a compact response—and the schema covers parameter origins. Minor gaps like prerequisites for snapshot IDs are already handled in the schema descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/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. The description adds value beyond the schema by explaining that the tool can load "full or partial" and that passing false keeps the response compact when only metadata is needed. This semantic guidance helps the agent choose appropriate flag values.

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 states a specific action—"Load a single project snapshot"—and distinguishes it from sibling tools like pathrule_list_snapshots and pathrule_take_snapshot. It also communicates that the tool supports full or partial loads, making its purpose and scope immediately clear.

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 implies when to use the compact form by saying "when you only need metadata," which gives useful within-tool guidance. However, it does not explicitly state when to prefer this tool over alternatives such as listing snapshots or retrieving the tree separately, so cross-tool selection guidance is left mostly implicit.

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

All Pathrule toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

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