Skip to main content
Glama

update_track_index

Overwrite the index.md of an existing track to update its summary, status, or linked resources.

Instructions

Overwrite index.md for an existing conductor track. Use to update the track summary, status, or linked resources.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
trackNameYes
contentYes

Implementation Reference

  • Core handler for update_track_index. Validates the track slug, calls fs.writeTrackFile to overwrite index.md, and returns a result with trackName, filename, updated flag, and content length.
    async function updateTrackIndex(trackName: string, content: string): Promise<UpdateTrackFileResult> {
      assertSafeSlug(trackName);
      await fs.writeTrackFile(tracksDir, trackName, 'index.md', content);
      return { trackName, filename: 'index.md', updated: true, length: content.length };
    }
  • Zod schema for update_track_index: validates trackName (non-empty string) and content (non-empty string).
    export const UpdateTrackIndexSchema = z.object({
      trackName: z.string().min(1),
      content: z.string().min(1),
    });
  • Registers the 'update_track_index' tool on the MCP server with its schema and handler that delegates to manager.updateTrackIndex.
    server.tool(
      'update_track_index',
      'Overwrite index.md for an existing conductor track. Use to update the track summary, status, or linked resources.',
      UpdateTrackIndexSchema.shape,
      async (args) => {
        const result = await manager.updateTrackIndex(args.trackName, args.content);
        return {
          content: [{ type: 'text' as const, text: JSON.stringify(result, null, 2) }],
        };
      },
    );
  • Low-level file write helper: writes content to index.md for the given track directory. Called by the handler.
    async function writeTrackFile(tracksDir: string, trackName: string, filename: string, content: string): Promise<void> {
      const filePath = join(tracksDir, trackName, filename);
      await writeFile(filePath, content, { encoding: 'utf8' });
    }
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 for behavioral traits. It states 'overwrite', implying destructive replacement, but lacks details on side effects, error conditions, permissions, or what happens to existing content. The minimal 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 a single sentence, very concise and front-loaded with the verb and resource. However, it may be overly concise given the lack of other documentation, sacrificing completeness for brevity.

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?

The tool has 2 required parameters, no output schema, and no annotations. The description omits essential context: what index.md is, what a conductor track is, expected content format, and whether the operation is idempotent. An AI agent would need additional domain knowledge to use this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It mentions 'track summary, status, or linked resources' but does not explicitly map to the two parameters (trackName, content). No format, length, or example values are provided, leaving the agent to infer parameter meaning.

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 tool overwrites index.md for an existing conductor track, specifying the verb 'overwrite' and the resource. It also lists use cases: update track summary, status, or linked resources. This distinguishes it from siblings like create_track and get_track_index.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'use to update the track summary, status, or linked resources', providing clear context for when to use. However, it does not mention when not to use or differentiate from alternatives like update_track_plan or update_track_spec, which limits guidance for tool selection.

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/2loch-ness6/mempalace-mcp-dev'

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