Skip to main content
Glama

list_chapters

Retrieve a paginated listing of chapters from BookStack wiki instances to view and manage chapter content with customizable sorting options.

Instructions

Get a listing of chapters visible to the user

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
countNoNumber of items per page
sortNoSort parameter

Implementation Reference

  • The execution logic for the 'list_chapters' tool. Parses arguments with PaginationSchema, calls BookStackClient.getChapters, and formats the response.
    case "list_chapters": {
      const params = PaginationSchema.parse(args);
      const result = await client.getChapters(params);
      return formatApiResponse(result.data, result.total);
    }
  • Tool definition object for 'list_chapters' including its name, description, and input JSON Schema.
    {
      name: "list_chapters",
      description: "Get a listing of chapters visible to the user",
      inputSchema: {
        type: "object",
        properties: {
          page: { type: "number", description: "Page number for pagination" },
          count: { type: "number", description: "Number of items per page" },
          sort: { type: "string", description: "Sort parameter" },
        },
      },
    },
  • src/index.ts:57-59 (registration)
    Registers the 'list_chapters' tool (via createContentTools) into the allTools array provided to the MCP server's listTools handler.
      ...createContentTools(bookStackClient),
      ...createSearchAndUserTools(bookStackClient),
    ];
  • src/index.ts:124-126 (registration)
    Routes calls to 'list_chapters' (listed in contentToolNames at line 83) to the handleContentTool function.
    if (contentToolNames.includes(name)) {
      result = await handleContentTool(name, args, bookStackClient);
    } else if (searchUserToolNames.includes(name)) {
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool retrieves chapters 'visible to the user', hinting at access control, but doesn't describe other traits like pagination behavior (implied by parameters but not explained), rate limits, authentication needs, or what 'visible' entails. For a list tool with zero annotation coverage, this is a significant gap in transparency.

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 a single, efficient sentence that front-loads the core purpose ('Get a listing of chapters') and adds a useful qualifier ('visible to the user'). There is zero waste, and every word earns its place, making it appropriately sized for a simple list tool.

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?

Given the tool's low complexity (a list operation), 100% schema coverage, and no output schema, the description is minimally adequate. It covers the basic purpose but lacks details on behavioral traits (e.g., pagination, visibility rules) and usage guidelines. With no annotations, it should do more to compensate, but it's not completely inadequate for a straightforward tool.

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 input schema has 100% description coverage, with clear documentation for 'page', 'count', and 'sort'. The description adds no parameter-specific information beyond implying a listing operation. According to the rules, with high schema coverage (>80%), the baseline is 3 even with no param info in the description. This is met, but no extra value is provided.

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 clearly states the action ('Get a listing') and resource ('chapters'), specifying that it retrieves chapters 'visible to the user'. It distinguishes from siblings like 'get_chapter' (singular) and 'list_books' (different resource), though it doesn't explicitly contrast with 'search_all' which might overlap. The purpose is specific but could be more precise about scope versus alternatives.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to prefer 'list_chapters' over 'get_chapter' (for single chapter) or 'search_all' (for broader queries), nor does it specify prerequisites or exclusions. Usage is implied by the verb 'Get a listing', but explicit context is missing.

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/lautarobarba/bookstack_mcp_server'

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