Skip to main content
Glama

get_list

Read-only

Without id: list the lists you own, most recently updated first, as {total, returned, offset, lists} (id, name, slug, description, books count, privacy; no books), paginated with limit/offset.

Instructions

Without id: list the lists you own, most recently updated first, as {total, returned, offset, lists} (id, name, slug, description, books count, privacy; no books), paginated with limit/offset. With id: get that list (yours or another user's) including a 'books' array in list order (position, book_id, title, slug, authors), paginated with books_limit/books_offset. Read-only. Find other users' lists with search_books(query_type='List').

Input Schema

NameRequiredDescriptionDefault
idNoList ID. Omit to list your own lists.
limitNoWithout id: max lists to return (default 50, max 200).
offsetNoWithout id: offset for pagination (default 0).
books_limitNoWith id: max books to return (default 25, max 100).
books_offsetNoWith id: offset for book pagination (default 0).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.0.0
    • removedInput schema / properties / book_limit
      Removed value: -{
      -  "description": "With id: max books to return (default 25, max 100).",
      -  "type": "integer"
      -}
    • removedInput schema / properties / book_offset
      Removed value: -{
      -  "description": "With id: offset for book pagination (default 0).",
      -  "type": "integer"
      -}
    • addedInput schema / properties / books_limit
      Added value: +{
      +  "description": "With id: max books to return (default 25, max 100).",
      +  "type": "integer"
      +}
    • addedInput schema / properties / books_offset
      Added value: +{
      +  "description": "With id: offset for book pagination (default 0).",
      +  "type": "integer"
      +}
  2. Changed6 schema fields changedv0.8.0
    • changedInput schema / properties / book_limit / description
      Previous value: -"Max books to return (default 25, max 100)."New value: +"With id: max books to return (default 25, max 100)."
    • changedInput schema / properties / book_offset / description
      Previous value: -"Offset for book pagination (default 0)."New value: +"With id: offset for book pagination (default 0)."
    • changedInput schema / properties / id / description
      Previous value: -"Hardcover list ID (use get_my_lists to find IDs)."New value: +"List ID. Omit to list your own lists."
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Without id: max lists to return (default 50, max 200).",
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Without id: offset for pagination (default 0).",
      +  "type": "integer"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "id"
      -]
  3. First observedv0.4.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only say readOnly/openWorld; the description goes much further by disclosing default sort order (most recently updated first), the pagination scheme in each mode, and that list contents come back in list order with a books array. It also clarifies cross-user readability, which the annotations do not.

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?

Front-loaded with the mode split, then per-mode return shape and pagination, then the sibling pointer. Three dense clauses, no repetition, every phrase carries information.

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?

There is no output schema, so the description must carry the return contract, and it does: it enumerates the top-level envelope {total, returned, offset, lists}, the per-list fields, and the nested books fields. An agent has everything needed to call it and interpret the response.

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 each parameter description already states 'Without id' / 'With id' scope plus defaults and maxima. The description restates that same mode-to-parameter mapping and adds no syntax or format detail beyond it, so it sits at the baseline.

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+resource and splits the tool into its two modes (list your own lists vs. fetch a single list) with the exact return shape for each. That dual-mode framing lets an agent distinguish it from siblings like search_books or get_user_library without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly conditions usage: omit id to enumerate your own lists, supply id to fetch one list (yours or another user's). It also names the alternative for discovering other users' lists, search_books(query_type='List'), which is the exact routing decision an agent needs.

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