Skip to main content
Glama

note_list

Read-onlyIdempotent

Retrieve and filter project notes by type, tags, or related entities to track decisions, meetings, blockers, and progress within structured project management.

Instructions

List notes with optional filters. Returns notes sorted by most recent first.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
note_typeNo
related_entity_typeNo
related_entity_idNo
tagNoFilter by a single tag
limitNo

Implementation Reference

  • Implementation of the 'note_list' tool handler.
    function handleNoteList(args: Record<string, unknown>) {
      const db = getDb();
      const noteType = args.note_type as string | undefined;
      const relatedEntityType = args.related_entity_type as string | undefined;
      const relatedEntityId = args.related_entity_id as number | undefined;
      const tag = args.tag as string | undefined;
      const limit = (args.limit as number) ?? 30;
    
      const whereClauses: string[] = [];
      const params: unknown[] = [];
    
      if (noteType) {
        whereClauses.push('note_type = ?');
        params.push(noteType);
      }
      if (relatedEntityType) {
        whereClauses.push('related_entity_type = ?');
        params.push(relatedEntityType);
      }
      if (relatedEntityId !== undefined) {
        whereClauses.push('related_entity_id = ?');
        params.push(relatedEntityId);
      }
      if (tag) {
        addTagFilter(whereClauses, params, tag, 'notes');
      }
    
      const whereStr = whereClauses.length > 0 ? `WHERE ${whereClauses.join(' AND ')}` : '';
    
      const sql = `SELECT * FROM notes ${whereStr} ORDER BY created_at DESC LIMIT ?`;
      params.push(limit);
    
      return db.prepare(sql).all(...params);
    }
  • Definition and schema for the 'note_list' tool.
    {
      name: 'note_list',
      description: 'List notes with optional filters. Returns notes sorted by most recent first.',
      annotations: { title: 'List Notes', readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: false },
      inputSchema: {
        type: 'object',
        properties: {
          note_type: {
            type: 'string',
            enum: ['general', 'decision', 'context', 'meeting', 'technical', 'blocker', 'progress', 'release'],
          },
          related_entity_type: { type: 'string', enum: ['project', 'epic', 'task'] },
          related_entity_id: { type: 'integer' },
          tag: { type: 'string', description: 'Filter by a single tag' },
          limit: { type: 'integer', default: 30 },
        },
      },
    },
  • Registration of 'note_list' in the handlers map.
    note_list: handleNoteList,
Behavior4/5

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

Annotations provide readOnlyHint=true, destructiveHint=false, and idempotentHint=true, indicating safe, non-destructive operations. The description adds value by specifying the return order ('sorted by most recent first'), which isn't covered by annotations. It doesn't contradict annotations and provides useful behavioral context beyond the structured data.

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 concise and front-loaded with essential information in two sentences: the action and the return order. There is no wasted text, and it efficiently communicates the core functionality without unnecessary details.

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 complexity (5 parameters, low schema coverage, no output schema) and annotations covering safety, the description is adequate but has gaps. It explains the action and sorting but lacks details on parameter usage, error handling, or output format. It's minimally viable but could be more complete for a tool with multiple filters.

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 low at 20%, with only the 'tag' parameter having a description. The description mentions 'optional filters' but doesn't elaborate on specific parameters or their meanings. It adds minimal semantics beyond the schema, compensating slightly for the low coverage but not fully addressing the gap for the 5 parameters.

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 tool's purpose with a specific verb ('List') and resource ('notes'), and mentions optional filtering. It distinguishes from note_search by focusing on listing rather than searching, though it doesn't explicitly differentiate from note_save or note_delete. The description is not tautological and provides meaningful context.

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 for listing notes with filters, but doesn't explicitly state when to use this tool versus alternatives like note_search or note_save. It mentions optional filters, which gives some context, but lacks clear guidance on prerequisites, exclusions, or specific scenarios where this tool is preferred over siblings.

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/spranab/saga-mcp'

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