Skip to main content
Glama
vuluu2k
by vuluu2k

addNote

Add notes to organize ideas or learning content in your structured knowledge base, enabling automated organization and retrieval of information.

Instructions

Add a note to the ideas or learning section

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesThe note content
fileNoWhich section to add the note toideas

Implementation Reference

  • The core implementation of the addNote functionality, which handles file updates or creation in the brain.
    async addNote(text: string, section: "ideas" | "learning"): Promise<void> {
      const log = getLogger();
      const brainSection: BrainSection = `notes/${section}`;
    
      try {
        await this.sync.atomicUpdate(
          brainSection,
          (current) => appendNote(current, text),
          `feat(ai): add note to ${section}`
        );
        log.info("addNote", { section, text });
      } catch (err) {
        if (isNotFound(err)) {
          const title = section === "ideas" ? "Ideas" : "Learning";
          const content = appendNote(`# ${title}\n\n`, text);
          await this.sync.createSection(
            brainSection,
            content,
            `feat(ai): create ${section} with new note`
          );
          log.info("addNote: created file", { section });
          return;
        }
        throw err;
      }
    }
  • Registration of the "addNote" tool with its schema definition and handler execution.
    server.registerTool(
      "addNote",
      {
        description: "Add a note to the ideas or learning section",
        inputSchema: {
          content: z.string().describe("The note content"),
          file: z
            .enum(["ideas", "learning"])
            .optional()
            .default("ideas")
            .describe("Which section to add the note to"),
        },
      },
      toolHandler("addNote", async ({ content, file }) => {
        await brain.addNote(content, file);
        return { success: true };
      })
    );
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. While 'Add a note' implies a write operation, the description doesn't specify whether this requires authentication, what happens on success/failure, if there are rate limits, or how notes are stored/retrieved. It lacks critical context for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized for a simple tool, though it could be slightly more informative without losing conciseness.

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?

For a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain the outcome (e.g., what 'adding a note' entails, how to retrieve it later with 'getNotes'), behavioral traits like error handling, or differentiation from sibling tools, leaving significant gaps for an AI agent.

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%, with both parameters ('content' and 'file') well-documented in the schema. The description adds minimal value beyond the schema by mentioning 'ideas or learning section', which aligns with the 'file' enum values. This meets the baseline for high schema coverage.

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 ('Add a note') and target ('to the ideas or learning section'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate this tool from sibling tools like 'addKnowledge' or 'saveToInbox', which might also involve adding content to different sections.

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 'addKnowledge' or 'saveToInbox'. It mentions the target sections ('ideas' or 'learning') but doesn't explain what distinguishes notes from knowledge entries or inbox items, nor does it mention any prerequisites or exclusions.

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/vuluu2k/knowledge_mcp'

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