Skip to main content
Glama

note_list

List notes for project entities like organizations, projects, tickets, or tasks to review summaries and access details. Returns note IDs, creation dates, and previews for efficient project tracking.

Instructions

PROJECT MANAGEMENT (TPM): List notes for an entity. Returns id, created_at, preview (first 100 chars). Use note_get for full content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_typeYesType of entity
entity_idYesID of the entity
limitNoMax notes to return (default: 20, max: 50)

Implementation Reference

  • The handler logic for the 'note_list' tool inside _handle_tool function. Retrieves notes from the database for a given entity, applies pagination limit, and returns a JSON list containing note ID, creation time, and a preview of the content (first 100 chars).
    if name == "note_list":
        notes = db.get_notes(args["entity_type"], args["entity_id"])
        limit = min(args.get("limit", 20), 50)
        total = len(notes)
        notes = notes[:limit]
        # Return IDs + preview only - use note_get for full content
        result = [
            {
                "id": n.id,
                "created_at": n.created_at.isoformat(),
                "preview": n.content[:100] + "..." if len(n.content) > 100 else n.content,
            }
            for n in notes
        ]
        return _json({"notes": result, "limit": limit, "total": total})
  • Registration of the 'note_list' tool in the list_tools() function, including the tool name, description, and input schema definition.
    Tool(
        name="note_list",
        description="PROJECT MANAGEMENT (TPM): List notes for an entity. Returns id, created_at, preview (first 100 chars). Use note_get for full content.",
        inputSchema={
            "type": "object",
            "properties": {
                "entity_type": {
                    "type": "string",
                    "enum": ["org", "project", "ticket", "task"],
                    "description": "Type of entity",
                },
                "entity_id": {"type": "string", "description": "ID of the entity"},
                "limit": {
                    "type": "integer",
                    "description": "Max notes to return (default: 20, max: 50)",
                    "default": 20,
                },
            },
            "required": ["entity_type", "entity_id"],
        },
    ),
  • Input schema definition for the note_list tool, specifying properties like entity_type (enum), entity_id, and optional limit.
    inputSchema={
        "type": "object",
        "properties": {
            "entity_type": {
                "type": "string",
                "enum": ["org", "project", "ticket", "task"],
                "description": "Type of entity",
            },
            "entity_id": {"type": "string", "description": "ID of the entity"},
            "limit": {
                "type": "integer",
                "description": "Max notes to return (default: 20, max: 50)",
                "default": 20,
            },
        },
        "required": ["entity_type", "entity_id"],
    },
Behavior3/5

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

With no annotations provided, the description carries full burden. It discloses the return format (id, created_at, preview with character limit) and implies read-only behavior through 'List', but doesn't mention pagination, error conditions, permissions needed, or rate limits. It provides basic behavioral context but lacks comprehensive disclosure.

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 extremely concise (two sentences) with zero wasted words. It's front-loaded with the core purpose, followed by specific usage guidance. Every sentence earns its place by providing essential information.

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 list operation with no annotations and no output schema, the description provides good context: it explains what the tool does, what it returns, and when to use alternatives. However, it doesn't mention pagination behavior (though limit parameter is documented in schema) or potential error scenarios, leaving some gaps in completeness.

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 100%, so the schema already fully documents all 3 parameters. The description doesn't add any parameter-specific information beyond what's in the schema. This meets the baseline expectation when schema coverage is complete.

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 ('List'), resource ('notes for an entity'), and scope ('Returns id, created_at, preview (first 100 chars)'). It explicitly distinguishes from sibling 'note_get' by specifying this returns previews only, not full content.

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?

The description provides explicit guidance on when to use this tool vs alternatives: 'Use note_get for full content.' This clearly indicates this tool is for listing note previews while note_get is for retrieving complete note details.

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/urjitbhatia/tpm-mcp'

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