@paulp-o/opencode-auq 0.1.0

package/LICENSE

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2025 Frank Fiegel (frank@glama.ai)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,26 @@
+# AUQ OpenCode Plugin
+
+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
+```
+
+## Configure OpenCode
+
+Add to `opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["@paulp-o/opencode-auq"]
+}
+```
+
+## Notes
+
+- The plugin expects `auq` to be on `PATH` (global install or equivalent).
+- The tool name and parameters match the MCP server (`ask_user_questions`).

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { type Plugin } from "@opencode-ai/plugin";
+export declare const AskUserQuestionsPlugin: Plugin;
+export default AskUserQuestionsPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,110 @@
+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 runAuqAsk = async (payload) => new Promise((resolve, reject) => {
+    const child = spawn("auq", ["ask"], {
+        stdio: ["pipe", "pipe", "pipe"],
+    });
+    let stdout = "";
+    let stderr = "";
+    child.stdout.setEncoding("utf8");
+    child.stderr.setEncoding("utf8");
+    child.stdout.on("data", (chunk) => {
+        stdout += chunk;
+    });
+    child.stderr.on("data", (chunk) => {
+        stderr += chunk;
+    });
+    child.on("error", (error) => {
+        reject(new Error(`Failed to run \"auq ask\": ${error.message}. Is the auq CLI installed globally?`));
+    });
+    child.on("close", (code) => {
+        if (code === 0) {
+            resolve(stdout.trim());
+            return;
+        }
+        const detail = stderr.trim() || stdout.trim();
+        reject(new Error(detail || `auq ask exited with code ${code}`));
+    });
+    try {
+        child.stdin.write(JSON.stringify(payload));
+        child.stdin.end();
+    }
+    catch (error) {
+        reject(error);
+    }
+});
+export const AskUserQuestionsPlugin = async () => ({
+    tool: {
+        ask_user_questions: 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\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.",
+            args: {
+                questions: QuestionsSchema,
+            },
+            async execute(args) {
+                try {
+                    return await runAuqAsk({ questions: args.questions });
+                }
+                catch (error) {
+                    return `Error in session: ${String(error)}`;
+                }
+            },
+        }),
+    },
+});
+export default AskUserQuestionsPlugin;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@paulp-o/opencode-auq",
+  "version": "0.1.0",
+  "description": "OpenCode plugin that forwards ask_user_questions to the auq CLI",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "auq",
+    "ask-user-questions"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paulp-o/ask-user-questions-mcp.git",
+    "directory": "packages/opencode-plugin"
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "@opencode-ai/plugin": ">=1.0.0"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "^1.1.3",
+    "@tsconfig/node22": "^22.0.1",
+    "@types/node": "^22.13.0",
+    "typescript": "^5.8.3"
+  }
+}