@henrikogard/auroradocs-mcp 0.1.1

package/dist/toolCatalog.js

@@ -0,0 +1,423 @@
+const TOOL_EFFECTS = {
+    search_objects: 'read',
+    search: 'read',
+    list_objects: 'read',
+    list_recent: 'read',
+    wiki_search: 'read',
+    wiki_get_page: 'read',
+    wiki_related: 'read',
+    wiki_recent: 'read',
+    get_object: 'read',
+    list_workspace_members: 'read',
+    list_task_lists: 'read',
+    list_task_statuses: 'read',
+    list_week_plan: 'read',
+    schedule_task_block: 'write',
+    read_canvas: 'read',
+    get_mcp_tool_coverage: 'read',
+    get_mcp_workflow_recipes: 'read',
+    create_object: 'write',
+    create_task: 'write',
+    update_task: 'write',
+    update_object_title: 'write',
+    update_object: 'write',
+    set_content: 'write',
+    append_block: 'write',
+    set_property: 'write',
+    delete_object: 'write',
+};
+const TOOL_DEFINITIONS = [
+    {
+        name: 'search_objects',
+        description: 'Search for objects (pages, notes, tasks, etc.) in the workspace by title keyword.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: { type: 'string', description: 'Keyword to search for in object titles' },
+                type: { type: 'string', description: 'Optional object type filter (page, note, task, etc.)' },
+            },
+            required: ['query'],
+        },
+    },
+    {
+        name: 'search',
+        description: 'Alias for search_objects. Search workspace objects by title keyword.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: { type: 'string', description: 'Keyword to search for in object titles' },
+                type: { type: 'string', description: 'Optional object type filter (page, note, task, etc.)' },
+            },
+            required: ['query'],
+        },
+    },
+    {
+        name: 'list_objects',
+        description: 'List objects in the workspace, optionally filtered by type.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                type: { type: 'string', description: 'Optional object type to filter by' },
+                limit: { type: 'number', description: 'Maximum results to return (default 20)' },
+            },
+        },
+    },
+    {
+        name: 'list_recent',
+        description: 'List the most recently updated objects in the workspace.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                type: { type: 'string', description: 'Optional object type to filter by' },
+                limit: { type: 'number', description: 'Maximum results to return (default 20)' },
+            },
+        },
+    },
+    {
+        name: 'wiki_search',
+        description: 'Search workspace knowledge and return citation-ready sources.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: { type: 'string', description: 'Search query to run against workspace knowledge' },
+                limit: { type: 'number', description: 'Maximum results to return (default 20, max 50)' },
+            },
+            required: ['query'],
+        },
+    },
+    {
+        name: 'wiki_get_page',
+        description: 'Read one object as a wiki source and optionally include full text.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                includeFullText: { type: 'boolean', description: 'Include the full readable text payload when available' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'wiki_related',
+        description: 'Find related workspace sources for an object.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                limit: { type: 'number', description: 'Maximum results to return (default 6, max 10)' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'wiki_recent',
+        description: 'List recently updated readable workspace sources.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                limit: { type: 'number', description: 'Maximum results to return (default 6, max 10)' },
+            },
+        },
+    },
+    {
+        name: 'get_object',
+        description: 'Get the content, details, and properties of a specific object by its ID.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'list_workspace_members',
+        description: 'List workspace members with their roles.',
+        inputSchema: { type: 'object', properties: {} },
+    },
+    {
+        name: 'list_task_lists',
+        description: 'List available task lists in the workspace.',
+        inputSchema: { type: 'object', properties: {} },
+    },
+    {
+        name: 'list_task_statuses',
+        description: 'List the task statuses available in the workspace.',
+        inputSchema: { type: 'object', properties: {} },
+    },
+    {
+        name: 'list_week_plan',
+        description: 'Return the AuroraDocs Week Planning view for a Monday-start week, including scheduled and optionally unscheduled tasks.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                anchor_date: { type: 'string', description: 'Date inside the requested week, formatted YYYY-MM-DD. Defaults to today.' },
+                include_unscheduled: { type: 'boolean', description: 'Include incomplete tasks without a due date. Defaults to true.' },
+                unscheduled_limit: { type: 'number', description: 'Maximum unscheduled tasks to return. Defaults to 12, max 50.' },
+            },
+        },
+    },
+    {
+        name: 'schedule_task_block',
+        description: 'Schedule an existing task into Week Planning or create a task-backed time block.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                mode: { type: 'string', description: 'schedule_existing_task or create_time_block' },
+                task_id: { type: 'string', description: 'Existing task object ID when mode is schedule_existing_task' },
+                title: { type: 'string', description: 'Time-block title when mode is create_time_block' },
+                date: { type: 'string', description: 'Target date formatted YYYY-MM-DD' },
+                start_time: { type: 'string', description: 'Optional start time formatted HH:mm' },
+                duration_minutes: { type: 'number', description: 'Time-block duration in minutes. Defaults to 30.' },
+            },
+            required: ['mode', 'date'],
+        },
+    },
+    {
+        name: 'read_canvas',
+        description: 'Read a Canvas object structure, including cards/nodes and edges/links, without modifying the canvas.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'Canvas object ID' },
+                include_text: { type: 'boolean', description: 'Include card text when available. Defaults to true.' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'get_mcp_tool_coverage',
+        description: 'Return AuroraDocs MCP tool coverage areas, implemented tools, and prioritized gaps.',
+        inputSchema: { type: 'object', properties: {} },
+    },
+    {
+        name: 'get_mcp_workflow_recipes',
+        description: 'Return documented agent workflow recipes and the MCP tools/scopes they use.',
+        inputSchema: { type: 'object', properties: {} },
+    },
+    {
+        name: 'create_object',
+        description: 'Create a new non-task object (page, note, bookmark, etc.) in the workspace. Use create_task for tasks.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                type: { type: 'string', description: 'Object type: page, note, bookmark, etc.' },
+                title: { type: 'string', description: 'Title for the new object' },
+            },
+            required: ['type', 'title'],
+        },
+    },
+    {
+        name: 'create_task',
+        description: 'Create a new task in the workspace with full task fields. Assignees can be names, emails, or user IDs. Task list can be a name or ID.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                title: { type: 'string', description: 'Task title' },
+                status: { type: 'string', description: 'Task status (e.g. To Do, In Progress, Done)' },
+                priority: { type: 'string', description: 'Priority: Low, Medium, High, or Urgent' },
+                due_date: { type: 'string', description: 'Due date in ISO 8601 (e.g. 2026-04-15 or 2026-04-15T22:00)' },
+                assignees: { oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }], description: 'Assignee names, emails, or user IDs (array or comma-separated)' },
+                task_list: { type: 'string', description: 'Task list name or ID' },
+                labels: { oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }], description: 'Labels/tags (array or comma-separated)' },
+                description: { type: 'string', description: 'Task description' },
+            },
+            required: ['title'],
+        },
+    },
+    {
+        name: 'update_task',
+        description: 'Update an existing task. Only provided fields are changed. Empty strings/arrays clear optional fields.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The task object ID' },
+                title: { type: 'string', description: 'New task title' },
+                status: { type: 'string', description: 'Task status' },
+                priority: { type: 'string', description: 'Priority: Low, Medium, High, Urgent, or empty to clear' },
+                due_date: { type: 'string', description: 'Due date (ISO 8601) or empty to clear' },
+                assignees: { oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }], description: 'Assignees (names/emails/IDs) or empty to clear' },
+                task_list: { type: 'string', description: 'Task list name/ID or empty to clear' },
+                labels: { oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }], description: 'Labels or empty to clear' },
+                description: { type: 'string', description: 'Task description or empty to clear' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'update_object_title',
+        description: 'Update the title of an existing object.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                title: { type: 'string', description: 'The new title' },
+            },
+            required: ['id', 'title'],
+        },
+    },
+    {
+        name: 'update_object',
+        description: 'Update an existing object title and/or replace its plain-text content.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                title: { type: 'string', description: 'Optional new title' },
+                text: { type: 'string', description: 'Optional plain text content to replace the existing content' },
+                content: { type: 'string', description: 'Alias for text' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'set_content',
+        description: 'Set the text content of an object. The text is converted to a structured document format.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                text: { type: 'string', description: 'Plain text content (newlines become paragraphs)' },
+            },
+            required: ['id'],
+        },
+    },
+    {
+        name: 'append_block',
+        description: 'Append plain text to the end of an object as one or more paragraph blocks.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID' },
+                text: { type: 'string', description: 'Plain text to append (newlines become paragraphs)' },
+                content: { type: 'string', description: 'Alias for text' },
+            },
+            required: ['id', 'text'],
+        },
+    },
+    {
+        name: 'set_property',
+        description: 'Set a generic property value on an object. For task-specific fields, use create_task or update_task instead.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                object_id: { type: 'string', description: 'The object ID' },
+                key: { type: 'string', description: 'Property key/name' },
+                value_type: { type: 'string', description: 'Value type: text, date, number, boolean' },
+                value: { type: 'string', description: 'The value to set' },
+            },
+            required: ['object_id', 'key', 'value_type', 'value'],
+        },
+    },
+    {
+        name: 'delete_object',
+        description: 'Soft-delete an object (moves to trash). This is reversible.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                id: { type: 'string', description: 'The object ID to delete' },
+            },
+            required: ['id'],
+        },
+    },
+];
+export function getToolDefinitions() {
+    return TOOL_DEFINITIONS.map((tool) => ({
+        ...tool,
+        inputSchema: {
+            ...tool.inputSchema,
+            properties: { ...tool.inputSchema.properties },
+            required: tool.inputSchema.required ? [...tool.inputSchema.required] : undefined,
+        },
+    }));
+}
+export function getToolEffect(name) {
+    return TOOL_EFFECTS[name];
+}
+export function getToolEffects() {
+    return { ...TOOL_EFFECTS };
+}
+export function getMcpToolCoverageAudit() {
+    return {
+        generatedAt: '2026-07-08',
+        areas: [
+            {
+                id: 'knowledge',
+                label: 'Knowledge search and source lookup',
+                status: 'covered',
+                implementedTools: ['wiki_search', 'wiki_get_page', 'wiki_related', 'wiki_recent', 'get_object'],
+                missingTools: [],
+            },
+            {
+                id: 'tasks',
+                label: 'Task triage and planning',
+                status: 'covered',
+                implementedTools: ['list_task_lists', 'list_task_statuses', 'create_task', 'update_task'],
+                missingTools: [],
+            },
+            {
+                id: 'objects',
+                label: 'Object CRUD',
+                status: 'partial',
+                implementedTools: ['search_objects', 'list_objects', 'list_recent', 'create_object', 'update_object', 'append_block', 'delete_object'],
+                missingTools: [
+                    {
+                        name: 'restore_object',
+                        priority: 'low',
+                        reason: 'Deletes are reversible in the app, but MCP currently lacks an explicit trash restore command.',
+                    },
+                ],
+            },
+            {
+                id: 'calendar',
+                label: 'Calendar and week planning',
+                status: 'covered',
+                implementedTools: ['list_week_plan', 'schedule_task_block'],
+                missingTools: [],
+            },
+            {
+                id: 'canvas',
+                label: 'Canvas and visual planning',
+                status: 'covered',
+                implementedTools: ['read_canvas'],
+                missingTools: [],
+            },
+        ],
+    };
+}
+export function getMcpWorkflowRecipes() {
+    return [
+        {
+            id: 'weekly_summary',
+            title: 'Weekly summary',
+            goal: 'Summarize recent workspace changes and outstanding work for a weekly review.',
+            requiredScopes: ['search', 'read:objects', 'read:content', 'tasks'],
+            toolSteps: ['wiki_recent', 'wiki_search', 'list_task_statuses', 'list_objects'],
+            prompt: 'Review recent sources, search for this week or active project terms, then summarize completed work, open decisions, and next actions with citations.',
+        },
+        {
+            id: 'task_triage',
+            title: 'Task triage',
+            goal: 'Review unsorted or stale tasks and propose status, priority, list, or assignee updates.',
+            requiredScopes: ['read:objects', 'tasks', 'write:objects'],
+            toolSteps: ['list_task_lists', 'list_task_statuses', 'list_objects', 'get_object', 'update_task'],
+            prompt: 'List task objects, inspect unclear items, then update only fields the user explicitly confirms or that match the agreed triage rule.',
+        },
+        {
+            id: 'research_synthesis',
+            title: 'Research synthesis',
+            goal: 'Find relevant project sources and produce a citation-backed synthesis.',
+            requiredScopes: ['search', 'read:objects', 'read:content'],
+            toolSteps: ['wiki_search', 'wiki_get_page', 'wiki_related'],
+            prompt: 'Search for the topic, read the top sources, follow related items, then answer with citations and a separate uncertainty list.',
+        },
+        {
+            id: 'source_lookup',
+            title: 'Source lookup',
+            goal: 'Locate the source object behind a claim, task, or project reference.',
+            requiredScopes: ['search', 'read:objects'],
+            toolSteps: ['search_objects', 'wiki_search', 'wiki_get_page'],
+            prompt: 'Search by title and content terms, return the best matching object IDs/deep links, and explain which matched fields support each result.',
+        },
+    ];
+}

package/dist/tools.d.ts

@@ -0,0 +1,105 @@
+import type { WorkspaceKnowledgeSource } from './auroraClient.js';
+import type { McpCanvasReadResult, McpWeekPlan } from './planningTools.js';
+import type { McpToolCoverageAudit, McpWorkflowRecipe } from './toolCatalog.js';
+export type ToolResult = {
+    type: 'objects';
+    objects: {
+        id: string;
+        title: string | null;
+        type: string;
+        icon: string | null;
+    }[];
+} | {
+    type: 'object';
+    object: {
+        id: string;
+        title: string | null;
+        type: string;
+        icon: string | null;
+    };
+    content: string | null;
+    properties: Record<string, string>;
+} | {
+    type: 'created';
+    id: string;
+    title: string;
+} | {
+    type: 'task_created';
+    id: string;
+    title: string;
+    status: string | null;
+    task_list_name: string | null;
+} | {
+    type: 'task_updated';
+    id: string;
+    title: string;
+    changed_fields: string[];
+} | {
+    type: 'object_updated';
+    id: string;
+    changed_fields: string[];
+} | {
+    type: 'updated';
+    id: string;
+    title: string;
+} | {
+    type: 'deleted';
+    id: string;
+} | {
+    type: 'content_set';
+    id: string;
+} | {
+    type: 'content_appended';
+    id: string;
+} | {
+    type: 'property_set';
+    objectId: string;
+    key: string;
+    value: string;
+} | {
+    type: 'knowledge_sources';
+    sources: WorkspaceKnowledgeSource[];
+} | {
+    type: 'mcp_tool_coverage';
+    audit: McpToolCoverageAudit;
+} | {
+    type: 'mcp_workflow_recipes';
+    recipes: McpWorkflowRecipe[];
+} | {
+    type: 'week_plan';
+    plan: McpWeekPlan;
+} | {
+    type: 'canvas';
+    canvas: McpCanvasReadResult;
+} | {
+    type: 'scheduled_task_block';
+    id: string;
+    title: string | null;
+    due_date: string;
+    mode: string;
+} | {
+    type: 'members';
+    members: {
+        id: string;
+        name: string | null;
+        email: string;
+        role: string;
+    }[];
+} | {
+    type: 'task_lists';
+    task_lists: {
+        id: string;
+        name: string;
+    }[];
+} | {
+    type: 'task_statuses';
+    statuses: string[];
+} | {
+    type: 'no_op';
+    message: string;
+} | {
+    type: 'error';
+    message: string;
+};
+export declare function executeToolCall(name: string, input: Record<string, unknown>, workspaceId: string): Promise<ToolResult>;
+export declare function formatToolResult(result: ToolResult): string;