@doclift/workflows-mcp 0.1.0

package/dist/tools/variables.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { ApiClient } from '../client.js';
+export declare const registerVariables: (server: McpServer, api: ApiClient, base: string) => void;

package/dist/tools/variables.js

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+import { respond, templateId } from './shared.js';
+export const registerVariables = (server, api, base) => {
+    // ----------------------------------------------------------- the variables
+    server.registerTool('variable_list', {
+        title: 'List the variables',
+        description: 'Every variable of the workflow, with its type, whether it is required, and its allowed values.',
+        inputSchema: { template_id: templateId },
+        annotations: { readOnlyHint: true },
+    }, async ({ template_id }) => respond(await api.get(`${base}/templates/${template_id}/variables`)));
+    server.registerTool('variable_create', {
+        title: 'Declare a variable',
+        description: 'Create every variable BEFORE writing content that cites one. A citation is a string, not a ' +
+            'foreign key, so content written first saves cleanly and leaves a broken reference behind. ' +
+            'Names are alphanumeric plus underscore, lowercased; a name that breaks the rule is refused, ' +
+            'not rewritten.',
+        inputSchema: {
+            template_id: templateId,
+            name: z.string().min(1),
+            field_type: z.string().describe('See capabilities.variable.field_types.'),
+            description: z.string().min(1).describe('Required. What the variable holds, for whoever fills it in.'),
+            required: z.boolean().optional(),
+            seed_value: z.string().optional().describe('What the preview shows in its place.'),
+            allowed_values: z.array(z.string()).optional().describe('select and radio only.'),
+            fields: z.array(z.record(z.unknown())).optional().describe('The row columns of a collection.'),
+        },
+        annotations: { readOnlyHint: false, destructiveHint: false },
+    }, async ({ template_id, ...variable }) => respond(await api.post(`${base}/templates/${template_id}/variables`, { variable })));
+    server.registerTool('variable_update', {
+        title: 'Change a variable',
+        description: 'Renaming a variable does NOT rewrite the tokens and conditions that cite it — they keep the ' +
+            'old name and become broken references. Run workflow_validate after a rename.',
+        inputSchema: {
+            template_id: templateId,
+            id: z.number().int(),
+            name: z.string().min(1).optional(),
+            field_type: z.string().optional(),
+            description: z.string().optional(),
+            required: z.boolean().optional(),
+            seed_value: z.string().optional(),
+            allowed_values: z.array(z.string()).optional(),
+            fields: z.array(z.record(z.unknown())).optional(),
+        },
+        annotations: { readOnlyHint: false, destructiveHint: false },
+    }, async ({ template_id, id, ...variable }) => respond(await api.patch(`${base}/templates/${template_id}/variables/${id}`, { variable })));
+    server.registerTool('variable_delete', {
+        title: 'Delete a variable',
+        description: 'Succeeds even when tokens and conditions still cite it: the citations survive, broken, so that ' +
+            'they can be reported rather than silently cascaded away. Run workflow_validate afterwards.',
+        inputSchema: { template_id: templateId, id: z.number().int() },
+        annotations: { readOnlyHint: false, destructiveHint: true },
+    }, async ({ template_id, id }) => respond(await api.delete(`${base}/templates/${template_id}/variables/${id}`)));
+};

package/dist/tools/workflows.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { ApiClient } from '../client.js';
+export declare const registerWorkflows: (server: McpServer, api: ApiClient, base: string) => void;

package/dist/tools/workflows.js

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+import { respond, templateId } from './shared.js';
+export const registerWorkflows = (server, api, base) => {
+    // ---------------------------------------------------------------- workflows
+    server.registerTool('workflow_list', {
+        title: 'List workflows',
+        description: 'The organization\'s workflows, most recently changed first. Archived ones are not listed.',
+        inputSchema: { page: z.number().int().positive().optional() },
+        annotations: { readOnlyHint: true },
+    }, async ({ page }) => respond(await api.get(`${base}/templates`, { page })));
+    server.registerTool('workflow_get', {
+        title: 'Read one workflow',
+        description: 'Title, description, page setup, counters, and whether a human currently holds it in the ' +
+            'builder. While `being_edited` is true, every write to this workflow is refused with 409.',
+        inputSchema: { id: templateId },
+        annotations: { readOnlyHint: true },
+    }, async ({ id }) => respond(await api.get(`${base}/templates/${id}`)));
+    server.registerTool('workflow_create', {
+        title: 'Create a workflow',
+        description: 'Creates an empty workflow. It carries no content of its own — everything lives in its ' +
+            'sections. Title and description are both required.',
+        inputSchema: {
+            title: z.string().min(1),
+            description: z.string().min(1),
+            orientation: z.string().optional().describe('portrait or landscape — see capabilities.page.'),
+            margin_top: z.number().optional().describe('In millimetres, like the other three.'),
+            margin_right: z.number().optional(),
+            margin_bottom: z.number().optional(),
+            margin_left: z.number().optional(),
+        },
+        annotations: { readOnlyHint: false, destructiveHint: false },
+    }, async (attributes) => respond(await api.post(`${base}/templates`, { template: attributes })));
+    server.registerTool('workflow_update', {
+        title: 'Update a workflow',
+        description: 'Title, description, orientation and the four margins, which are in millimetres. The tree is ' +
+            'edited through the section tools.',
+        inputSchema: {
+            id: templateId,
+            title: z.string().min(1).optional(),
+            description: z.string().min(1).optional(),
+            orientation: z.string().optional(),
+            margin_top: z.number().optional(),
+            margin_right: z.number().optional(),
+            margin_bottom: z.number().optional(),
+            margin_left: z.number().optional(),
+        },
+        annotations: { readOnlyHint: false, destructiveHint: false },
+    }, async ({ id, ...attributes }) => respond(await api.patch(`${base}/templates/${id}`, { template: attributes })));
+    server.registerTool('workflow_delete', {
+        title: 'Archive a workflow',
+        description: 'Archives rather than deletes: documents already generated keep pointing at the workflow that ' +
+            'produced them. An archived workflow stops being listed and stops being reachable.',
+        inputSchema: { id: templateId },
+        annotations: { readOnlyHint: false, destructiveHint: true },
+    }, async ({ id }) => respond(await api.delete(`${base}/templates/${id}`)));
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@doclift/workflows-mcp",
+  "version": "0.1.0",
+  "description": "MCP server over the Doclift workflow authoring API",
+  "license": "MIT",
+  "homepage": "https://www.doclift.io/docs/getting-started",
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "doclift",
+    "workflow",
+    "pdf",
+    "document-generation"
+  ],
+  "type": "module",
+  "bin": {
+    "doclift-workflows-mcp": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "start": "node dist/index.js",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.30.0",
+    "zod": "^3.25.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}