Skip to main content
Glama

list_notebooks

Retrieve available library notebooks with metadata to select appropriate sources for AI-powered document queries and synthesized responses.

Instructions

List all library notebooks with metadata (name, topics, use cases, URL). Use this to present options, then ask which notebook to use for the task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The main handler function for the 'list_notebooks' tool. It logs the call, retrieves notebooks from the library, and returns them in a standardized ToolResult format, with error handling.
     * Handle list_notebooks tool
     */
    async handleListNotebooks(): Promise<ToolResult<{ notebooks: any[] }>> {
      log.info(`🔧 [TOOL] list_notebooks called`);
    
      try {
        const notebooks = this.library.listNotebooks();
        log.success(`✅ [TOOL] list_notebooks completed (${notebooks.length} notebooks)`);
        return {
          success: true,
          data: { notebooks },
        };
      } catch (error) {
        const errorMessage = error instanceof Error ? error.message : String(error);
        log.error(`❌ [TOOL] list_notebooks failed: ${errorMessage}`);
        return {
          success: false,
          error: errorMessage,
        };
      }
    }
  • The input/output schema definition for the 'list_notebooks' tool, part of the notebookManagementTools array. It has no required input parameters.
    {
      name: "list_notebooks",
      description:
        "List all library notebooks with metadata (name, topics, use cases, URL). " +
        "Use this to present options, then ask which notebook to use for the task.",
      inputSchema: {
        type: "object",
        properties: {},
      },
    },
  • The underlying library method called by the handler, which simply returns the array of notebooks from the stored library data.
    listNotebooks(): NotebookEntry[] {
      return this.library.notebooks;
    }
  • src/index.ts:185-187 (registration)
    The dispatch case in the main MCP tool execution switch statement that routes 'list_notebooks' calls to the appropriate handler method.
    case "list_notebooks":
      result = await this.toolHandlers.handleListNotebooks();
      break;

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the burden of conveying behavior. It reveals that the tool returns list metadata (name, topics, use cases, URL), but it does not mention pagination, ordering, authentication requirements, or potential side effects. For a simple list operation this is adequate but not richly transparent.

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?

Two sentences with no filler: the first states exactly what is listed and what metadata is included; the second gives a clear next-step workflow. Well front-loaded and economical.

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?

For a simple parameterless list tool, the description covers what it returns and how to use the result. It lacks details like whether the result is sorted or limited, but the core invocation context is complete.

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?

The tool has zero parameters, so there is nothing for the description to explain beyond confirming it needs no input. The baseline for a parameterless tool is 4, and the description does not mislead.

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 verb ('List') and resource ('library notebooks'), and includes the metadata fields returned. It is clearly a listing operation, distinct from 'get_notebook' or 'search_notebooks', though it does not explicitly name those siblings or explain the difference.

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

Usage Guidelines4/5

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

The description gives clear workflow guidance: use this tool to present options, then ask which notebook to use. It does not mention alternative tools or when to prefer search_notebooks or get_notebook, but the provided context is actionable.

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