Skip to main content
Glama
hichana

Goal Story MCP Server

by hichana

goalstory_update_step_notes

Add context, insights, or reflections in markdown format to capture valuable information from discussions about goal progress.

Instructions

Update step notes with additional context, insights, or reflections in markdown format. Use this to capture valuable information from discussions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique identifier of the step to update.
notesYesAdditional context, insights, or reflections in markdown format.

Implementation Reference

  • Handler function that makes a PATCH request to the API endpoint `/step/notes/${id}` to update the step's notes with the provided content.
    async (args) => {
      const url = `${GOALSTORY_API_BASE_URL}/step/notes/${args.id}`;
      const body = {
        id: args.id,
        notes: args.notes,
      };
      const result = await doRequest(url, "PATCH", body);
      return {
        content: [
          {
            type: "text",
            text: `Step notes updated:\n${JSON.stringify(result, null, 2)}`,
          },
        ],
        isError: false,
      };
    },
  • src/index.ts:587-608 (registration)
    MCP server.tool registration for the 'goalstory_update_step_notes' tool, referencing the tool definition from tools.ts.
    server.tool(
      UPDATE_STEP_NOTES_TOOL.name,
      UPDATE_STEP_NOTES_TOOL.description,
      UPDATE_STEP_NOTES_TOOL.inputSchema.shape,
      async (args) => {
        const url = `${GOALSTORY_API_BASE_URL}/step/notes/${args.id}`;
        const body = {
          id: args.id,
          notes: args.notes,
        };
        const result = await doRequest(url, "PATCH", body);
        return {
          content: [
            {
              type: "text",
              text: `Step notes updated:\n${JSON.stringify(result, null, 2)}`,
            },
          ],
          isError: false,
        };
      },
    );
  • Tool definition object including name, description, and Zod inputSchema for validation.
    export const UPDATE_STEP_NOTES_TOOL = {
      name: "goalstory_update_step_notes",
      description:
        "Update step notes with additional context, insights, or reflections in markdown format. Use this to capture valuable information from discussions.",
      inputSchema: z.object({
        id: z.string().describe("Unique identifier of the step to update."),
        notes: z
          .string()
          .describe(
            "Additional context, insights, or reflections in markdown format.",
          ),
      }),
    };
  • TypeScript interface defining the input shape for the tool.
    export interface GoalstoryUpdateStepNotesInput {
      id: string;
      notes: string;
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Update step notes' implying a mutation, but lacks details on permissions, whether notes are appended or replaced, error handling, or response format. The mention of 'markdown format' adds some context, but behavioral disclosure is insufficient 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 concise with two sentences that are front-loaded and relevant. However, the second sentence ('Use this to capture...') could be more integrated into the first for better flow, and some redundancy exists with the schema descriptions.

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 a mutation tool with two parameters, the description is incomplete. It lacks details on behavioral traits, error cases, and response expectations, making it inadequate for safe and effective use by 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 ('id' and 'notes') well-documented in the schema. The description adds minimal value by reinforcing 'notes' as 'additional context, insights, or reflections in markdown format,' but doesn't provide new semantics beyond the schema. Baseline 3 is appropriate given 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 verb ('Update step notes') and the resource ('step notes'), specifying the content format ('markdown format') and purpose ('capture valuable information from discussions'). However, it doesn't explicitly differentiate from the sibling tool 'goalstory_update_step', which likely updates different step attributes beyond notes.

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 minimal guidance with 'Use this to capture valuable information from discussions,' which implies usage for note-taking but offers no explicit when-to-use vs. alternatives, prerequisites, or exclusions. No comparison to sibling tools like 'goalstory_update_step' is made.

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/hichana/goalstory-mcp'

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