Skip to main content
Glama

read_properties

Read-only

Lists property keys used in Burrow page metadata, showing how many pages set each key; supports filtering by key text and limiting results.

Instructions

Property keys in use (structured page metadata) with how many pages set each.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoDefault 50
filterNoOnly keys containing this text

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered by structured data. The description adds that each returned key includes a usage count, which is genuine extra context, but it says nothing about result ordering or the fact that results are truncated by the limit parameter.

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?

A single compact clause that front-loads the resource and its returned attribute with no filler. It is terse to the point of being a fragment, but nothing needs to be removed.

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?

There is no output schema, and the description does cover the shape of each returned item (key plus page count). It does not mention that results are paginated with a default of 50 keys, which matters for an inventory-style tool with a 500-key ceiling.

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 both limit and filter are already documented in the schema. The description adds no further meaning about filtering semantics, matching behavior, or ordering, so the baseline of 3 applies.

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?

The description states a specific resource (property keys) plus the extra payload (count of pages setting each), and clarifies that these are structured page metadata rather than something else. It is not explicitly contrasted with the sibling read_pages_by_property, so an agent must infer that this one enumerates keys rather than fetching pages.

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?

Usage is implied: this is the discovery tool for learning which property keys exist, presumably before calling read_pages_by_property or write_properties. There is no explicit when-to-use or when-not-to-use statement, and no alternative is named.

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