close_file
Destructive
Close open DOCX or Google Docs file sessions to free resources and ensure data integrity. Use to end individual sessions or confirm closure of all sessions.
Instructions
Close an open file session, or close all sessions with explicit confirmation. Supports DOCX and Google Docs.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_path | No | Path to the DOCX file. | |
| google_doc_id | No | Google Doc ID or URL (alternative to file_path). Extract from URL: docs.google.com/document/d/{ID}/edit | |
| clear_all | No | ||
| confirm | No |
Implementation Reference
- The handler implementation for the `close_file` tool, which handles closing document file sessions.
export async function closeFile( manager: SessionManager, params: { file_path?: string; clear_all?: boolean; confirm?: boolean; }, ): Promise<ToolResponse> { try { const clearAll = params.clear_all === true; const filePath = typeof params.file_path === 'string' ? params.file_path.trim() : ''; const hasFilePath = filePath.length > 0; if (clearAll) { if (params.confirm !== true) { return err( 'CONFIRMATION_REQUIRED', 'clear_all=true requires confirm=true.', 'Re-run with confirm=true to close every active file session.', ); } if (hasFilePath) { return err( 'INVALID_CLEAR_TARGET', 'clear_all=true cannot be combined with file_path.', 'Use clear_all=true, confirm=true by itself, or remove clear_all and target a file_path.', ); } const clearedPaths = await manager.clearAllSessions(); return ok({ clear_mode: 'all', cleared_file_paths: clearedPaths, cleared_count: clearedPaths.length, }); } if (!hasFilePath) { return err( 'INVALID_CLEAR_TARGET', 'close_file requires file_path, or clear_all=true.', 'Provide file_path to close a file session, or clear_all=true with confirm=true.', ); } const cleared = await manager.clearSessionByPath(filePath); if (!cleared) { return ok({ clear_mode: 'file_path', file_path: filePath, cleared_file_paths: [], cleared_count: 0, message: 'No active session found for this file.', }); } return ok({ clear_mode: 'file_path', file_path: cleared, cleared_file_paths: [cleared], cleared_count: 1, }); } catch (e: unknown) { return err( 'CLOSE_FILE_ERROR', `Failed to close file session(s): ${errorMessage(e)}`, ); } } - The tool definition and schema for `close_file` in the tool catalog.
name: 'close_file', description: 'Close an open file session, or close all sessions with explicit confirmation. Supports DOCX and Google Docs.', input: z.object({ ...FILE_FIELD_OPTIONAL, ...GOOGLE_DOC_ID_FIELD, clear_all: z.boolean().optional(), confirm: z.boolean().optional(), }), annotations: { readOnlyHint: false, destructiveHint: true }, }, - packages/docx-mcp/src/server.ts:122-124 (registration)Registration of the `close_file` tool call in the server dispatcher.
case 'close_file': if (isGDocsRequest(args)) return await dispatchGDocs(sessions, args, 'close_file'); return await closeFile(sessions, args as Parameters<typeof closeFile>[1]);