Skip to main content
Glama

add_changelog_entry

Adds a new entry to the project changelog to document code changes, including type, description, and affected files for tracking modifications.

Instructions

Add an entry to the project changelog

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
descriptionYesDescription of the change
filesChangedYesFiles that were changed
typeYes
breakingChangeNoWhether this is a breaking change
impactNo

Implementation Reference

  • MCP tool handler that processes the tool call, enriches with current session context, and delegates to ChangelogManager.addChangelogEntry
    case 'add_changelog_entry': {
      const currentMemory = await this.memoryManager.getProjectMemory();
      const description = args.description as string;
      const filesChanged = args.filesChanged as string[];
      const type = args.type as 'added' | 'changed' | 'deprecated' | 'removed' | 'fixed' | 'security';
      const breakingChange = (args.breakingChange as boolean) || false;
      const impact = (args.impact as 'major' | 'minor' | 'patch') || 'minor';
    
      await this.changelogManager.addChangelogEntry({
        sessionId: currentMemory.currentSession.sessionId,
        task: currentMemory.currentSession.task,
        type,
        description,
        filesChanged,
        breakingChange,
        approvals: {},
        impact
      });
      return { content: [{ type: 'text', text: 'Changelog entry added successfully' }] };
    }
  • Input JSON schema for the add_changelog_entry tool defining parameters and validation rules
    inputSchema: {
      type: 'object',
      properties: {
        description: { type: 'string', description: 'Description of the change' },
        filesChanged: { type: 'array', items: { type: 'string' }, description: 'Files that were changed' },
        type: { type: 'string', enum: ['added', 'changed', 'deprecated', 'removed', 'fixed', 'security'] },
        breakingChange: { type: 'boolean', description: 'Whether this is a breaking change' },
        impact: { type: 'string', enum: ['major', 'minor', 'patch'] }
      },
      required: ['description', 'filesChanged', 'type']
    }
  • src/index.ts:688-701 (registration)
    Tool registration in MCP server's tools list, including name, description, and schema
      name: 'add_changelog_entry',
      description: 'Add an entry to the project changelog',
      inputSchema: {
        type: 'object',
        properties: {
          description: { type: 'string', description: 'Description of the change' },
          filesChanged: { type: 'array', items: { type: 'string' }, description: 'Files that were changed' },
          type: { type: 'string', enum: ['added', 'changed', 'deprecated', 'removed', 'fixed', 'security'] },
          breakingChange: { type: 'boolean', description: 'Whether this is a breaking change' },
          impact: { type: 'string', enum: ['major', 'minor', 'patch'] }
        },
        required: ['description', 'filesChanged', 'type']
      }
    },
  • Core helper method in ChangelogManager that persists the changelog entry to JSON file and regenerates Markdown changelog
    async addChangelogEntry(entry: Omit<ChangelogEntry, 'date'>): Promise<void> {
      try {
        const changelog = await this.getChangelog();
        
        const newEntry: ChangelogEntry = {
          ...entry,
          date: new Date().toISOString()
        };
    
        changelog.unshift(newEntry); // Add to beginning
        
        await fs.writeJson(this.changelogPath, changelog, { spaces: 2 });
        await this.updateMarkdownChangelog(changelog);
        
        console.log(chalk.green(`📝 Changelog entry added: ${entry.description}`));
      } catch (error) {
        console.error(chalk.red('Error adding changelog entry:'), error);
      }
    }
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. It states this is an 'Add' operation, implying mutation, but doesn't disclose behavioral traits like whether it requires specific permissions, if entries are permanent or reversible, or any rate limits. The description is minimal and lacks critical context for a write operation.

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 front-loaded and appropriately sized for the tool's complexity, making it easy to parse quickly.

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 the complexity (a write operation with 5 parameters, 3 required), no annotations, and no output schema, the description is incomplete. It doesn't explain what happens after adding an entry, such as return values or success indicators, leaving significant gaps for an AI agent to use it correctly.

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 description adds no parameter semantics beyond what the input schema provides. With 60% schema description coverage (3 of 5 parameters have descriptions), the baseline is 3. The description doesn't compensate for the undocumented parameters or provide additional context like format examples or constraints.

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 an entry') and the resource ('project changelog'), which is specific and unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'get_file_changelog' or 'get_recent_changes', which are read operations versus this write operation.

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. It doesn't mention prerequisites, such as needing an active project or session, or when to choose this over similar tools like 'update_file_metadata' for logging changes. Usage is implied but not stated.

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/keleshteri/mcp-memory'

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