@paulp-o/opencode-auq 1.3.2 → 2.0.0

package/README.md

@@ -5,8 +5,8 @@ OpenCode plugin that forwards `ask_user_questions` to the `auq ask` CLI.
 ## Install
 
 ```bash
-npm install -g auq-mcp-server
-npm install -g @paulp-o/opencode-auq
+bun add -g auq-mcp-server
+bun add -g @paulp-o/opencode-auq
 ```
 
 ## Configure OpenCode

package/dist/generated-schemas.d.ts

@@ -0,0 +1,16 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+ *
+ * This file is generated from src/shared/schemas.ts by scripts/sync-plugin-schemas.mjs
+ * Run "npm run sync-plugin-schemas" to regenerate.
+ *
+ * Generated at: 2026-02-06T03:21:22.056Z
+ */
+/**
+ * Comprehensive tool description - single source of truth.
+ * Used by MCP server and should be synced to opencode-plugin.
+ */
+declare const TOOL_DESCRIPTION: string;
+export declare const AskUserQuestionsArgs: any;
+export { TOOL_DESCRIPTION };
+//# sourceMappingURL=generated-schemas.d.ts.map

package/dist/generated-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-schemas.d.ts","sourceRoot":"","sources":["../src/generated-schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA4IH;;;GAGG;AACH,QAAA,MAAM,gBAAgB,QAWoD,CAAC;AAI3E,eAAO,MAAM,oBAAoB,EAAE,GAA4C,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/generated-schemas.js

@@ -0,0 +1,121 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT DIRECTLY
+ *
+ * This file is generated from src/shared/schemas.ts by scripts/sync-plugin-schemas.mjs
+ * Run "npm run sync-plugin-schemas" to regenerate.
+ *
+ * Generated at: 2026-02-06T03:21:22.056Z
+ */
+import { tool } from "@opencode-ai/plugin/tool";
+const z = tool.schema;
+/**
+ * Default limits - can be overridden by config
+ * These are the hard maximums enforced by the schema (config can only reduce, not increase)
+ */
+const SCHEMA_LIMITS = {
+    MAX_OPTIONS: 10,
+    MAX_QUESTIONS: 10,
+    MIN_OPTIONS: 2,
+    MIN_QUESTIONS: 1,
+};
+/**
+ * Default recommended limits (used when no config is provided)
+ */
+const DEFAULT_LIMITS = {
+    maxOptions: 5,
+    maxQuestions: 5,
+    recommendedOptions: 4,
+    recommendedQuestions: 4,
+};
+const OptionSchema = z.object({
+    label: z
+        .string()
+        .describe("The display text for this option. Should be concise (1-5 words). " +
+        "To mark as recommended, append '(recommended)' to the label text."),
+    description: z
+        .string()
+        .optional()
+        .describe("Explanation of what this option means or what will happen if chosen. " +
+        "Useful for providing context about trade-offs or implications."),
+});
+/**
+ * Create a QuestionSchema with configurable option limits
+ * @param maxOptions - Maximum number of options allowed (default: 4, max: 10)
+ */
+function createQuestionSchema(maxOptions = DEFAULT_LIMITS.maxOptions) {
+    // Clamp to valid range
+    const effectiveMax = Math.min(Math.max(maxOptions, SCHEMA_LIMITS.MIN_OPTIONS), SCHEMA_LIMITS.MAX_OPTIONS);
+    return z.object({
+        prompt: z
+            .string()
+            .describe("The complete question to ask the user. Should be clear, specific, and end with a question mark. " +
+            "Example: 'Which programming language do you want to use?' " +
+            "If multiSelect is true, phrase it accordingly, e.g. 'Which features do you want to enable?'"),
+        title: z
+            .string()
+            .min(1, "Question title is required. Provide a short summary like 'Language' or 'Framework'.")
+            .describe("Very short label displayed as a chip/tag (max 12 chars). " +
+            "Examples: 'Auth method', 'Library', 'Approach'. " +
+            "This title appears in the interface to help users quickly identify questions."),
+        options: z
+            .array(OptionSchema)
+            .min(SCHEMA_LIMITS.MIN_OPTIONS)
+            .max(effectiveMax)
+            .describe(`The available choices for this question. Must have ${SCHEMA_LIMITS.MIN_OPTIONS}-${effectiveMax} options. ` +
+            "Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). " +
+            "There should be no 'Other' option, that will be provided automatically."),
+        multiSelect: z
+            .boolean()
+            .describe("Set to true to allow the user to select multiple options instead of just one. " +
+            "Use when choices are not mutually exclusive. Default: false (single-select)"),
+    });
+}
+/**
+ * Create a QuestionsSchema with configurable limits
+ * @param maxQuestions - Maximum number of questions allowed (default: 4, max: 10)
+ * @param maxOptions - Maximum number of options per question (default: 4, max: 10)
+ */
+function createQuestionsSchema(maxQuestions = DEFAULT_LIMITS.maxQuestions, maxOptions = DEFAULT_LIMITS.maxOptions) {
+    const effectiveMaxQuestions = Math.min(Math.max(maxQuestions, SCHEMA_LIMITS.MIN_QUESTIONS), SCHEMA_LIMITS.MAX_QUESTIONS);
+    const questionSchema = createQuestionSchema(maxOptions);
+    return z
+        .array(questionSchema)
+        .min(SCHEMA_LIMITS.MIN_QUESTIONS)
+        .max(effectiveMaxQuestions);
+}
+/**
+ * Create the full parameters schema with configurable limits
+ * @param maxQuestions - Maximum number of questions (default: 4, max: 10)
+ * @param maxOptions - Maximum number of options per question (default: 4, max: 10)
+ */
+function createAskUserQuestionsParametersSchema(maxQuestions = DEFAULT_LIMITS.maxQuestions, maxOptions = DEFAULT_LIMITS.maxOptions) {
+    const questionsSchema = createQuestionsSchema(maxQuestions, maxOptions);
+    return z.object({
+        questions: questionsSchema.describe(`Questions to ask the user (1-${maxQuestions} questions). ` +
+            `Each question must include: prompt (full question text), title (short label, max 12 chars), ` +
+            `options (2-${maxOptions} choices with labels and descriptions), and multiSelect (boolean).`),
+    });
+}
+// Default schemas for backward compatibility (using DEFAULT_LIMITS)
+const QuestionSchema = createQuestionSchema();
+const QuestionsSchema = createQuestionsSchema();
+const AskUserQuestionsParametersSchema = createAskUserQuestionsParametersSchema();
+/**
+ * Comprehensive tool description - single source of truth.
+ * Used by MCP server and should be synced to opencode-plugin.
+ */
+const TOOL_DESCRIPTION = "Use this tool when you need to ask the user questions during execution. This allows you to:\n\n" +
+    "Gather user preferences or requirements\n" +
+    "Clarify ambiguous instructions\n" +
+    "Get decisions on implementation choices as you work\n" +
+    "Offer choices to the user about what direction to take.\n" +
+    "Usage notes:\n\n" +
+    'Users will always be able to select "Other" to provide custom text input\n' +
+    "Use multiSelect: true to allow multiple answers to be selected for a question\n" +
+    'Recommend an option unless absolutely necessary, make it the first option in the list and add "(Recommended)" at the end of the label\n' +
+    'For multiSelect questions, you MAY mark multiple options as "(Recommended)" if several choices are advisable\n' +
+    'Do NOT use this tool to ask "Is my plan ready?" or "Should I proceed?"';
+// Only export what the plugin needs
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const AskUserQuestionsArgs = AskUserQuestionsParametersSchema.shape;
+export { TOOL_DESCRIPTION };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAyHlD,eAAO,MAAM,sBAAsB,EAAE,MAcnC,CAAC;AAEH,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAuFlD,eAAO,MAAM,sBAAsB,EAAE,MAgDnC,CAAC;AAEH,eAAe,sBAAsB,CAAC"}

package/dist/index.js

@@ -1,55 +1,35 @@
 import { spawn } from "child_process";
 import { tool } from "@opencode-ai/plugin/tool";
-const z = tool.schema;
-const OptionSchema = z.object({
-    label: z
-        .string()
-        .describe("The display text for this option that the user will see and select. " +
-        "Should be concise (1-5 words) and clearly describe the choice."),
-    description: z
-        .string()
-        .optional()
-        .describe("Explanation of what this option means or what will happen if chosen. " +
-        "Useful for providing context about trade-offs or implications."),
-});
-const QuestionSchema = z.object({
-    prompt: z
-        .string()
-        .describe("The complete question to ask the user. Should be clear, specific, and end with a question mark. " +
-        "Example: 'Which programming language do you want to use?' " +
-        "If multiSelect is true, phrase it accordingly, e.g. 'Which features do you want to enable?'"),
-    title: z
-        .string()
-        .min(1, "Question title is required. Provide a short summary like 'Language' or 'Framework'.")
-        .describe("Very short label displayed as a chip/tag (max 12 chars). " +
-        "Examples: 'Auth method', 'Library', 'Approach'. " +
-        "This title appears in the interface to help users quickly identify questions."),
-    options: z
-        .array(OptionSchema)
-        .min(2)
-        .max(4)
-        .describe("The available choices for this question. Must have 2-4 options. " +
-        "Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). " +
-        "There should be no 'Other' option, that will be provided automatically."),
-    multiSelect: z
-        .boolean()
-        .describe("Set to true to allow the user to select multiple options instead of just one. " +
-        "Use when choices are not mutually exclusive. Default: false (single-select)"),
-});
-const QuestionsSchema = z.array(QuestionSchema).min(1).max(4);
-const AskUserQuestionsParametersSchema = z.object({
-    questions: QuestionsSchema.describe("Questions to ask the user (1-4 questions). " +
-        "Each question must include: prompt (full question text), title (short label, max 12 chars), " +
-        "options (2-4 choices with labels and descriptions), and multiSelect (boolean). " +
-        "Mark one choice as recommended if possible."),
-});
-const TOOL_DESCRIPTION = "Ask users structured questions during execution to gather preferences, clarify requirements, or make implementation decisions.\n\n" +
-    "FEATURES:\n" +
-    "- Non-blocking: doesn't halt AI workflow\n" +
-    "- 1-4 questions with 2-4 options each\n" +
-    "- Single/multi-select modes\n" +
-    "- Custom text input always available\n\n" +
-    "Returns formatted responses for continued reasoning.";
+// Schemas are auto-generated from src/shared/schemas.ts
+// Run "npm run sync-plugin-schemas" to regenerate
+import { AskUserQuestionsArgs, TOOL_DESCRIPTION } from "./generated-schemas.js";
+// Map tool callID -> derived title (used by tool.execute.after)
+const titleByCallId = new Map();
+/**
+ * Generate a summary title for the question set
+ * Format: "Questions: [Q0] Language, [Q1] Framework"
+ */
+function generateQuestionSummary(questions) {
+    const questionLabels = questions
+        .map((q, i) => `[Q${i}] ${q.title}`)
+        .join(", ");
+    return `Questions: ${questionLabels}`;
+}
+function safeSummaryFromArgs(args) {
+    if (!args || typeof args !== "object")
+        return null;
+    const maybeQuestions = args.questions;
+    if (!Array.isArray(maybeQuestions))
+        return null;
+    const questions = maybeQuestions;
+    const labels = questions
+        .map((q, i) => {
+        const title = (q.title || q.prompt || "").toString().trim();
+        return `[Q${i}] ${title || "(untitled)"}`;
+    })
+        .join(", ");
+    return `Questions: ${labels}`;
+}
 const runAuqAsk = async (payload) => new Promise((resolve, reject) => {
     const child = spawn("auq", ["ask"], {
         stdio: ["pipe", "pipe", "pipe"],
@@ -87,10 +67,26 @@ export const AskUserQuestionsPlugin = async () => ({
     tool: {
         ask_user_questions: tool({
             description: TOOL_DESCRIPTION,
-            args: AskUserQuestionsParametersSchema.shape,
-            async execute(args) {
+            args: AskUserQuestionsArgs,
+            async execute(args, context) {
+                // Best-effort: set call metadata (some OpenCode UIs won't render this title).
+                const questions = args.questions;
+                const summary = generateQuestionSummary(questions);
+                context.metadata({
+                    title: summary,
+                    metadata: { auqQuestionSummary: summary },
+                });
                 try {
-                    return await runAuqAsk({ questions: args.questions });
+                    // Get working directory from OpenCode context
+                    const workingDirectory = context.directory || context.worktree;
+                    // Build payload explicitly
+                    const payload = {
+                        questions,
+                    };
+                    if (workingDirectory) {
+                        payload.workingDirectory = workingDirectory;
+                    }
+                    return await runAuqAsk(payload);
                 }
                 catch (error) {
                     return `Error in session: ${String(error)}`;
@@ -98,5 +94,22 @@ export const AskUserQuestionsPlugin = async () => ({
             },
         }),
     },
+    // Force the tool call title in OpenCode UI.
+    "tool.execute.before": async (input, output) => {
+        if (input.tool !== "ask_user_questions")
+            return;
+        const summary = safeSummaryFromArgs(output.args);
+        if (summary)
+            titleByCallId.set(input.callID, summary);
+    },
+    "tool.execute.after": async (input, output) => {
+        if (input.tool !== "ask_user_questions")
+            return;
+        const summary = titleByCallId.get(input.callID);
+        if (summary) {
+            output.title = summary;
+        }
+        titleByCallId.delete(input.callID);
+    },
 });
 export default AskUserQuestionsPlugin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@paulp-o/opencode-auq",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "description": "OpenCode plugin that forwards ask_user_questions to the auq CLI",
   "type": "module",
   "main": "dist/index.js",
@@ -13,7 +13,7 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "bun run build",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "keywords": [
@@ -35,7 +35,7 @@
     "@opencode-ai/plugin": ">=1.0.0"
   },
   "devDependencies": {
-    "@opencode-ai/plugin": "^1.1.3",
+    "@opencode-ai/plugin": "^1.1.25",
     "@tsconfig/node22": "^22.0.1",
     "@types/node": "^22.13.0",
     "typescript": "^5.8.3"

package/dist/schemas.d.ts

@@ -1,37 +0,0 @@
-import { z } from "zod";
-export declare const OptionSchema: z.ZodObject<{
-    label: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export declare const QuestionSchema: z.ZodObject<{
-    prompt: z.ZodString;
-    title: z.ZodString;
-    options: z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    multiSelect: z.ZodBoolean;
-}, z.core.$strip>;
-export declare const QuestionsSchema: z.ZodArray<z.ZodObject<{
-    prompt: z.ZodString;
-    title: z.ZodString;
-    options: z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    multiSelect: z.ZodBoolean;
-}, z.core.$strip>>;
-export declare const AskUserQuestionsParametersSchema: z.ZodObject<{
-    questions: z.ZodArray<z.ZodObject<{
-        prompt: z.ZodString;
-        title: z.ZodString;
-        options: z.ZodArray<z.ZodObject<{
-            label: z.ZodString;
-            description: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>;
-        multiSelect: z.ZodBoolean;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export declare const TOOL_DESCRIPTION: string;
-export type QuestionInput = z.infer<typeof QuestionSchema>;
-//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,YAAY;;;iBAcvB,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;;;;iBAkCzB,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;kBAAwC,CAAC;AAErE,eAAO,MAAM,gCAAgC;;;;;;;;;;iBAO3C,CAAC;AAEH,eAAO,MAAM,gBAAgB,QAqBgC,CAAC;AAE9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/schemas.js

@@ -1,64 +0,0 @@
-import { z } from "zod";
-export const OptionSchema = z.object({
-    label: z
-        .string()
-        .describe("The display text for this option that the user will see and select. " +
-        "Should be concise (1-5 words) and clearly describe the choice."),
-    description: z
-        .string()
-        .optional()
-        .describe("Explanation of what this option means or what will happen if chosen. " +
-        "Useful for providing context about trade-offs or implications."),
-});
-export const QuestionSchema = z.object({
-    prompt: z
-        .string()
-        .describe("The complete question to ask the user. Should be clear, specific, and end with a question mark. " +
-        "Example: 'Which programming language do you want to use?' " +
-        "If multiSelect is true, phrase it accordingly, e.g. 'Which features do you want to enable?'"),
-    title: z
-        .string()
-        .min(1, "Question title is required. Provide a short summary like 'Language' or 'Framework'.")
-        .describe("Very short label displayed as a chip/tag (max 12 chars). " +
-        "Examples: 'Auth method', 'Library', 'Approach'. " +
-        "This title appears in the interface to help users quickly identify questions."),
-    options: z
-        .array(OptionSchema)
-        .min(2)
-        .max(4)
-        .describe("The available choices for this question. Must have 2-4 options. " +
-        "Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). " +
-        "There should be no 'Other' option, that will be provided automatically."),
-    multiSelect: z
-        .boolean()
-        .describe("Set to true to allow the user to select multiple options instead of just one. " +
-        "Use when choices are not mutually exclusive. Default: false (single-select)"),
-});
-export const QuestionsSchema = z.array(QuestionSchema).min(1).max(4);
-export const AskUserQuestionsParametersSchema = z.object({
-    questions: QuestionsSchema.describe("Questions to ask the user (1-4 questions). " +
-        "Each question must include: prompt (full question text), title (short label, max 12 chars), " +
-        "options (2-4 choices with labels and descriptions), and multiSelect (boolean). " +
-        "Mark one choice as recommended if possible."),
-});
-export const TOOL_DESCRIPTION = "Use this tool when you need to ask the user questions during execution. " +
-    "This allows you to:\n" +
-    "1. Gather user preferences or requirements\n" +
-    "2. Clarify ambiguous instructions\n" +
-    "3. Get decisions on implementation choices as you work\n" +
-    "4. Offer choices to the user about what direction to take\n\n" +
-    "FEATURES:\n" +
-    "- Ask 1-4 structured questions via an interactive terminal interface\n" +
-    "- Each question includes 2-4 multiple-choice options with explanatory descriptions\n" +
-    "- Users can always provide custom free-text input as an alternative to predefined options\n" +
-    "- Single-select mode (default): User picks ONE option or provides custom text\n" +
-    "- Multi-select mode (multiSelect: true): User can select MULTIPLE options\n\n" +
-    "USAGE NOTES:\n" +
-    "- Always provide a descriptive 'title' field (max 12 chars) for each question\n" +
-    "- Use multiSelect: true when choices are not mutually exclusive\n" +
-    "- Option labels should be concise (1-5 words)\n" +
-    "- Questions should end with a question mark\n" +
-    "- Don't include an 'Other' option - it's provided automatically\n" +
-    "- Mark one choice as recommended if possible.\n\n" +
-    "- If user seems not aware how to answer the question, inform them that they need to install the 'auq' cli tool.\n\n" +
-    "Returns a formatted summary of all questions and answers.";