OmniFocus MCP Server

Instructions

Implementation Reference

• src/omnifocus/client.ts:69-80 (handler)

  Primary handler function implementing the core logic for retrieving all tasks from OmniFocus by executing a JXA script via osascript.

  async getAllTasks(filters: TaskFilters = {}): Promise<OmniFocusTask[]> {
    console.error('[DEBUG] getAllTasks called with filters:', JSON.stringify(filters));
    const jxaScript = buildJxaScriptForTasks(false);
    const output = this.executeScript(jxaScript);
    try {
      const tasks = JSON.parse(output);
      return tasks;
    } catch (e) {
      console.error('[DEBUG] Failed to parse OmniFocus JXA output:', output);
      throw new Error('Failed to parse OmniFocus output as JSON');
    }
  }

• src/server.ts:80-82 (handler)

  MCP tool dispatch handler that invokes the OmniFocusClient.getAllTasks() method when the 'get_all_tasks' tool is called.

  case 'get_all_tasks':
    result = await this.client.getAllTasks();
    break;

• src/server.ts:51-55 (registration)

  Registration of the 'get_all_tasks' tool in the MCP listTools response, including name, description, and input schema.

  {
    name: 'get_all_tasks',
    description: "Call this tool to get a list of all tasks from OmniFocus, including completed ones. Use it when the user explicitly asks for 'all tasks' or 'completed tasks'.",
    inputSchema: { type: 'object', properties: {} }
  },

• src/types/omnifocus.ts:6-32 (schema)

  Type definition for OmniFocusTask, which structures the output returned by the get_all_tasks tool.

  export interface OmniFocusTask {
    id: string;
    name: string;
    note: string;
    completed: boolean;
    completionDate?: string | null;
    creationDate: string;
    modificationDate: string;
    dueDate?: string | null;
    deferDate?: string | null;
    estimatedMinutes?: number | null;
    flagged: boolean;
    repetitionRule?: string | null;
    sequential: boolean;
    project?: {
      id: string;
      name: string;
    } | null;
    context?: {
      id: string;
      name: string;
    } | null;
    containingProject?: {
      id: string;
      name: string;
    } | null;
  }

• src/omnifocus/omnifocus-jxa.ts:3-73 (helper)

  Helper function that generates the JavaScript for Automation (JXA) script used by getAllTasks to query all tasks from OmniFocus.

  export function buildJxaScriptForTasks(activeOnly: boolean): string {
    return `
      (() => {
        const app = Application('OmniFocus');
        app.includeStandardAdditions = true;
        const ofDoc = app.defaultDocument;
        function safe(obj, method) {
          try { return obj && typeof obj[method] === 'function' ? obj[method]() : null; } catch { return null; }
        }
        function getContext(task) {
          const ctx = safe(task, 'context');
          return ctx ? { id: safe(ctx, 'id'), name: safe(ctx, 'name') } : null;
        }
        function getProject(task) {
          const proj = safe(task, 'containingProject');
          return proj ? { id: safe(proj, 'id'), name: safe(proj, 'name') } : null;
        }
        function isInTemplatesFolder(project) {
          let folder = safe(project, 'folder');
          while (folder) {
            if (safe(folder, 'name') === 'Templates') return true;
            folder = safe(folder, 'parentFolder');
          }
          return false;
        }
        function isExcludedTask(task) {
          const name = safe(task, 'name') || '';
          const note = safe(task, 'note') || '';
          if (name.includes('«') || name.includes('»') || note.includes('«') || note.includes('»')) return true;
          if (name.includes('⚙️') || note.includes('⚙️')) return true;
          const proj = safe(task, 'containingProject');
          if (!proj) return false;
          return isInTemplatesFolder(proj);
        }
        function getTaskData(task) {
          return {
            id: safe(task, 'id'),
            name: safe(task, 'name'),
            note: safe(task, 'note'),
            completed: safe(task, 'completed'),
            status: safe(task, 'status'),
            completionDate: safe(task, 'completionDate') ? safe(task, 'completionDate').toISOString() : null,
            creationDate: safe(task, 'creationDate') ? safe(task, 'creationDate').toISOString() : null,
            modificationDate: safe(task, 'modificationDate') ? safe(task, 'modificationDate').toISOString() : null,
            dueDate: safe(task, 'dueDate') ? safe(task, 'dueDate').toISOString() : null,
            deferDate: safe(task, 'deferDate') ? safe(task, 'deferDate').toISOString() : null,
            estimatedMinutes: safe(task, 'estimatedMinutes'),
            flagged: safe(task, 'flagged'),
            repetitionRule: safe(task, 'repetitionRule'),
            sequential: safe(task, 'sequential'),
            project: safe(task, 'project'),
            context: getContext(task),
            containingProject: getProject(task)
          };
        }
        const allTasks = Array.from(ofDoc.flattenedTasks());
        const filteredTasks = allTasks.filter(task => {
          if (isExcludedTask(task)) return false;
          const statusObj = safe(task, 'status') ? task.status() : null;
          const statusName = statusObj ? safe(statusObj, 'name') : '';
          if (${activeOnly ? 'true' : 'false'}) {
            // Exclude completed or dropped tasks
            return !task.completed() && !/dropped/i.test(statusName);
          }
          return true;
        });
        const result = filteredTasks.map(getTaskData);
        return JSON.stringify(result);
      })();
    `;
  }