Skip to main content
Glama

read_shelf

Get shelf details by providing its ID or name. Access metadata and content for knowledge base organization.

Instructions

Get details of a specific shelf by ID or name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shelf_idNoID of the shelf to retrieve. Required if name is not provided.
nameNoName of the shelf to retrieve. Required if shelf_id is not provided.
Behavior3/5

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

With no annotations, the description carries full burden. 'Get details' implies a read-only, non-destructive operation, but does not disclose any other behavioral traits such as pagination, error handling, or authentication needs.

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?

A single, direct sentence with no wasted words. Front-loaded with the action and resource.

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 simple tool with 2 parameters and no output schema, the description sufficiently conveys the purpose and input requirements. No additional context is needed.

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% with both parameters described. The description adds no new meaning beyond stating that identification is by ID or name, which the schema already conveys.

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 clearly states the verb 'Get', the resource 'details of a specific shelf', and the identifying criteria 'by ID or name'. It effectively distinguishes from sibling 'list_shelves' which returns multiple shelves.

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 usage when needing details of a single shelf, but lacks explicit guidance on when not to use or comparisons with alternatives like 'list_shelves'. No exclusions or prerequisites mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Derron-Knox/bookstack-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server