Skip to main content
Glama

interactive_edit_session

Destructive

Start an interactive editing session to manage complex edits across multiple files with guided instructions.

Instructions

Start an interactive editing session for complex edits

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesYesList of files to edit
instructionsNoInstructions for the editing session

Implementation Reference

  • Handler logic for 'interactive_edit_session' operation: creates an edit session ID using EditInstanceManager and returns it to the client.
    const sessionId = await this.editInstanceManager.createEditSession(operation.affectedFiles);
    
    try {
      switch (operation.type) {
        case 'interactive_edit_session':
          // Return the session ID for the client to use
          return { sessionId };
  • src/index.ts:306-329 (registration)
    Registers the 'interactive_edit_session' tool with MCP server including schema and annotations.
    mcpServer.registerTool({
      name: 'interactive_edit_session',
      description: 'Start an interactive editing session for complex edits',
      inputSchema: {
        type: 'object',
        properties: {
          files: {
            type: 'array',
            description: 'List of files to edit'
          },
          instructions: {
            type: 'string',
            description: 'Instructions for the editing session'
          }
        },
        required: ['files']
      },
      annotations: {
        readOnlyHint: false,
        destructiveHint: true,
        idempotentHint: false,
        openWorldHint: false
      }
    });
  • Input schema definition for the 'interactive_edit_session' tool.
    inputSchema: {
      type: 'object',
      properties: {
        files: {
          type: 'array',
          description: 'List of files to edit'
        },
        instructions: {
          type: 'string',
          description: 'Instructions for the editing session'
        }
      },
      required: ['files']
  • Helper function that creates an interactive edit session by spawning an Edit instance and opening the specified files.
    public async createEditSession(files: string[]): Promise<string> {
      const sessionId = uuidv4();
      const instance = await this.createInstance(sessionId);
    
      // Open all files
      for (const file of files) {
        await instance.openFile(file);
      }
    
      return sessionId;
    }
Behavior3/5

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

Annotations already indicate destructiveHint=true, readOnlyHint=false, etc., covering safety and mutability. The description adds minimal context by implying interactivity and complexity, but doesn't detail session behavior, side effects, or constraints like timeouts. It doesn't contradict annotations, so it's adequate but not rich.

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, concise sentence that front-loads the core action. It's efficient with no wasted words, though it could be more informative. It earns its place but leaves room for improvement in clarity.

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 tool's complexity (interactive session with destructive hints) and lack of output schema, the description is incomplete. It doesn't explain what the session entails, return values, or error handling. Annotations help, but more context is needed for effective use.

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%, so the schema fully documents the 'files' and 'instructions' parameters. The description adds no extra meaning beyond implying 'complex edits' might relate to 'instructions', but this is vague. Baseline 3 is appropriate as the schema carries the burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool's purpose as 'Start an interactive editing session for complex edits', which includes a verb ('Start') and resource ('interactive editing session'), but it's vague about what constitutes 'complex edits' and doesn't differentiate from siblings like 'smart_refactor' or 'backup_and_edit'. It provides a basic purpose but lacks specificity.

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 offers no guidance on when to use this tool versus alternatives. It doesn't mention scenarios, prerequisites, or exclusions, leaving the agent to infer usage from the name alone. With siblings like 'write_file' and 'smart_refactor', this gap is significant.

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/mixelpixx/edit-mcp'

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