Skip to main content
Glama

list_team_notes

Retrieve all notes within a specified team to manage and organize collaborative content efficiently using the HackMD API.

Instructions

List all notes in a team

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
teamPathYesTeam path

Implementation Reference

  • The asynchronous handler function for the 'list_team_notes' tool. It calls client.getTeamNotes(teamPath) via the HackMD API and returns the notes as formatted JSON or an error response.
    async ({ teamPath }) => {
      try {
        const notes = await client.getTeamNotes(teamPath);
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(notes, null, 2),
            },
          ],
        };
      } catch (error: any) {
        return {
          content: [{ type: "text", text: `Error: ${error.message}` }],
          isError: true,
        };
      }
    },
  • Registers the 'list_team_notes' tool on the MCP server, including name, description, input schema { teamPath: z.string() }, metadata hints, and inline handler function.
      "list_team_notes",
      "List all notes in a team",
      {
        teamPath: z.string().describe("Team path"),
      },
      {
        title: "Get a list of notes in a Team's workspace",
        readOnlyHint: true,
        openWorldHint: true,
      },
      async ({ teamPath }) => {
        try {
          const notes = await client.getTeamNotes(teamPath);
          return {
            content: [
              {
                type: "text",
                text: JSON.stringify(notes, null, 2),
              },
            ],
          };
        } catch (error: any) {
          return {
            content: [{ type: "text", text: `Error: ${error.message}` }],
            isError: true,
          };
        }
      },
    );
  • tools/index.ts:20-20 (registration)
    Calls registerTeamNotesApiTools(server, client), which registers the 'list_team_notes' tool among other team notes tools.
    registerTeamNotesApiTools(server, client);
  • index.ts:132-132 (registration)
    Calls registerAllTools(server, client) from tools/index.ts, which ultimately registers the 'list_team_notes' tool.
    registerAllTools(server, client);
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits like whether it's read-only, pagination behavior, error conditions, or rate limits. This is inadequate for a tool with potential complexity.

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 with zero waste. It's appropriately sized and front-loaded, clearly stating the core functionality without unnecessary elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and multiple sibling tools, the description is incomplete. It doesn't explain return values, error handling, or how it differs from similar tools, leaving significant gaps for an agent to operate effectively.

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 schema description coverage is 100%, so the schema already documents the 'teamPath' parameter. The description implies team-based filtering but adds no meaning beyond what the schema provides, such as format examples or constraints. Baseline 3 is appropriate here.

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 ('List') and resource ('notes in a team'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'list_teams' or 'list_user_notes' beyond the 'team' scope, which prevents a perfect score.

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 like 'list_user_otes' or 'get_note'. It lacks context about prerequisites, such as needing a valid team path, or exclusions, leaving the agent to infer usage from the name alone.

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

Related 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/yuna0x0/hackmd-mcp'

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