moai-adk 0.25.4__py3-none-any.whl → 0.41.0__py3-none-any.whl

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/configure/custom-tools.md

@@ -0,0 +1,197 @@
+---
+source: https://opencode.ai/docs/custom-tools/
+fetched: 2026-01-08
+title: Custom Tools
+---
+
+# Custom Tools in OpenCode
+
+## Overview
+
+OpenCode allows developers to create custom tools that language models can invoke during conversations, complementing built-in tools like `read`, `write`, and `bash`.
+
+## Key Implementation Details
+
+### Tool Definition Language
+
+Tools are defined using TypeScript or JavaScript, though they can execute scripts in any programming language.
+
+### File Locations
+
+| Location | Scope |
+|----------|-------|
+| `.opencode/tool/` | Project |
+| `~/.config/opencode/tool/` | Global |
+
+## Basic Structure
+
+The `tool()` helper from `@opencode-ai/plugin` provides type safety:
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export default tool({
+  description: "Query the project database",
+  args: {
+    query: tool.schema.string().describe("SQL query to execute"),
+  },
+  async execute(args) {
+    return `Executed query: ${args.query}`
+  },
+})
+```
+
+The filename becomes the tool name. This example creates a `database` tool if saved as `database.ts`.
+
+## Multiple Tools Per File
+
+Export multiple named tools to create `<filename>_<exportname>` tools:
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export const add = tool({
+  description: "Add two numbers",
+  args: {
+    a: tool.schema.number().describe("First number"),
+    b: tool.schema.number().describe("Second number"),
+  },
+  async execute(args) {
+    return String(args.a + args.b)
+  },
+})
+
+export const multiply = tool({
+  description: "Multiply two numbers",
+  args: {
+    a: tool.schema.number().describe("First number"),
+    b: tool.schema.number().describe("Second number"),
+  },
+  async execute(args) {
+    return String(args.a * args.b)
+  },
+})
+```
+
+If saved as `math.ts`, this creates `math_add` and `math_multiply` tools.
+
+## Arguments & Validation
+
+Use `tool.schema` (powered by Zod) for argument definitions:
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export default tool({
+  description: "Create a new user",
+  args: {
+    name: tool.schema.string().min(1).describe("User's name"),
+    email: tool.schema.string().email().describe("User's email"),
+    age: tool.schema.number().optional().describe("User's age"),
+    role: tool.schema.enum(["admin", "user", "guest"]).describe("User role"),
+  },
+  async execute(args) {
+    // Validation happens automatically
+    return `Created user: ${args.name}`
+  },
+})
+```
+
+### Schema Types
+
+| Type | Method |
+|------|--------|
+| String | `tool.schema.string()` |
+| Number | `tool.schema.number()` |
+| Boolean | `tool.schema.boolean()` |
+| Enum | `tool.schema.enum([...])` |
+| Optional | `.optional()` |
+| Array | `tool.schema.array(...)` |
+| Object | `tool.schema.object({...})` |
+
+## Context Access
+
+Tools receive session context through the `context` parameter:
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export default tool({
+  description: "Get session info",
+  args: {},
+  async execute(args, context) {
+    return JSON.stringify({
+      agent: context.agent,
+      sessionId: context.sessionId,
+      messageId: context.messageId,
+    })
+  },
+})
+```
+
+## Cross-Language Example
+
+Tools can invoke scripts in other languages:
+
+### TypeScript calling Python
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export default tool({
+  description: "Run Python calculation",
+  args: {
+    a: tool.schema.number().describe("First number"),
+    b: tool.schema.number().describe("Second number"),
+  },
+  async execute(args) {
+    const result = await Bun.$`python3 .opencode/tool/add.py ${args.a} ${args.b}`.text()
+    return result.trim()
+  },
+})
+```
+
+### Python script (add.py)
+
+```python
+import sys
+
+a = float(sys.argv[1])
+b = float(sys.argv[2])
+print(a + b)
+```
+
+## Full Example: API Client
+
+```typescript
+import { tool } from "@opencode-ai/plugin"
+
+export default tool({
+  description: "Make HTTP requests to external APIs",
+  args: {
+    url: tool.schema.string().url().describe("URL to fetch"),
+    method: tool.schema.enum(["GET", "POST", "PUT", "DELETE"]).default("GET"),
+    body: tool.schema.string().optional().describe("Request body"),
+  },
+  async execute(args) {
+    const response = await fetch(args.url, {
+      method: args.method,
+      body: args.body,
+      headers: {
+        "Content-Type": "application/json",
+      },
+    })
+
+    const data = await response.text()
+    return data
+  },
+})
+```
+
+## Best Practices
+
+1. **Clear descriptions**: Help the LLM understand when to use the tool
+2. **Validate inputs**: Use schema validation for safety
+3. **Handle errors**: Return helpful error messages
+4. **Keep focused**: Each tool should do one thing well
+5. **Document args**: Use `.describe()` for all arguments

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/configure/formatters.md

@@ -0,0 +1,164 @@
+---
+source: https://opencode.ai/docs/formatters/
+fetched: 2026-01-08
+title: Formatters Configuration
+---
+
+# OpenCode Formatters Documentation
+
+## Overview
+
+OpenCode automatically applies language-specific code formatting after files are written or edited, ensuring generated code aligns with project style standards.
+
+## Built-in Formatters
+
+| Formatter | Languages/Files |
+|-----------|-----------------|
+| Prettier | JavaScript, TypeScript, HTML, CSS, Markdown, JSON, YAML |
+| Biome | JavaScript, TypeScript, JSON |
+| Rustfmt | Rust (.rs) |
+| Gofmt | Go (.go) |
+| Ruff | Python |
+| uv | Python |
+
+Each formatter requires either a command-line tool or specific configuration file to function.
+
+## Automatic Formatting Process
+
+OpenCode automatically:
+1. Matches file extensions to enabled formatters
+2. Executes the appropriate command
+3. Applies changes without user intervention
+
+## Configuration
+
+Configure formatters via the `formatter` section in `opencode.json`.
+
+### Basic Configuration
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": {
+    "prettier": {
+      "disabled": false,
+      "command": ["prettier", "--write", "$FILE"]
+    }
+  }
+}
+```
+
+### Disable All Formatters
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": false
+}
+```
+
+### Disable Specific Formatter
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": {
+    "prettier": {
+      "disabled": true
+    }
+  }
+}
+```
+
+## Custom Formatter Example
+
+Define custom formatters with:
+- Command array with `$FILE` placeholder
+- Environment variables
+- Target file extensions
+
+### Deno Markdown Formatter
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": {
+    "deno-md": {
+      "command": ["deno", "fmt", "$FILE"],
+      "extensions": [".md", ".markdown"],
+      "env": {
+        "DENO_NO_UPDATE_CHECK": "1"
+      }
+    }
+  }
+}
+```
+
+### Override Prettier
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": {
+    "prettier": {
+      "command": ["npx", "prettier", "--write", "--config", ".prettierrc", "$FILE"],
+      "env": {
+        "NODE_ENV": "production"
+      }
+    }
+  }
+}
+```
+
+## Formatter Options
+
+| Option | Description |
+|--------|-------------|
+| `command` | Array of command and arguments, use `$FILE` for file path |
+| `extensions` | Array of file extensions to match |
+| `disabled` | Set to true to disable |
+| `env` | Environment variables for the formatter process |
+
+## Examples
+
+### Python with Black
+
+```json
+{
+  "formatter": {
+    "black": {
+      "command": ["black", "$FILE"],
+      "extensions": [".py"]
+    }
+  }
+}
+```
+
+### Multiple Formatters
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "formatter": {
+    "prettier": {
+      "command": ["prettier", "--write", "$FILE"],
+      "extensions": [".js", ".ts", ".jsx", ".tsx", ".json"]
+    },
+    "rustfmt": {
+      "command": ["rustfmt", "$FILE"],
+      "extensions": [".rs"]
+    },
+    "gofmt": {
+      "command": ["gofmt", "-w", "$FILE"],
+      "extensions": [".go"]
+    }
+  }
+}
+```
+
+## Best Practices
+
+1. **Match project config**: Use the same formatter settings as your project
+2. **Test locally**: Ensure formatters work before enabling in OpenCode
+3. **Use project formatters**: Prefer project-installed formatters over global
+4. **Check extensions**: Verify extension mappings match your file types

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/configure/keybinds.md

@@ -0,0 +1,150 @@
+---
+source: https://opencode.ai/docs/keybinds/
+fetched: 2026-01-08
+title: Keybinds Configuration
+---
+
+# OpenCode Keybinds Documentation
+
+## Overview
+
+OpenCode allows customization of keyboard shortcuts through the configuration file.
+
+## Leader Key Concept
+
+OpenCode implements a leader key system, defaulting to `ctrl+x`, which users press before the actual command shortcut.
+
+This design "avoids conflicts in your terminal."
+
+## Configuration Method
+
+Customize keybinds through the `opencode.json` file using the `"keybinds"` object:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "keybinds": {
+    "leader": "ctrl+x",
+    "submit": "return",
+    "cancel": "escape"
+  }
+}
+```
+
+## Notable Default Bindings
+
+| Action | Default Keybind |
+|--------|-----------------|
+| Leader key | `ctrl+x` |
+| New session | `<leader>n` |
+| Model list | `<leader>m` |
+| Agent list | `<leader>a` |
+| Command list | `ctrl+p` |
+| Input submission | `return` |
+| Add newline | `shift+return`, `ctrl+return`, `alt+return`, `ctrl+j` |
+
+## Common Keybinds
+
+| Action | Keybind |
+|--------|---------|
+| `session_new` | `<leader>n` |
+| `session_list` | `<leader>l` |
+| `model_list` | `<leader>m` |
+| `agent_list` | `<leader>a` |
+| `command_list` | `ctrl+p` |
+| `help` | `<leader>h` |
+| `compact` | `<leader>c` |
+| `details` | `<leader>d` |
+| `editor` | `<leader>e` |
+| `export` | `<leader>x` |
+| `share` | `<leader>s` |
+| `themes` | `<leader>t` |
+| `undo` | `<leader>u` |
+| `redo` | `<leader>r` |
+| `quit` | `<leader>q` |
+
+## Disabling Bindings
+
+Set any keybind value to `"none"` to disable it:
+
+```json
+{
+  "keybinds": {
+    "share": "none",
+    "export": "none"
+  }
+}
+```
+
+## Built-in Readline/Emacs Shortcuts
+
+The desktop prompt supports standard text editing shortcuts. These are **not configurable** through `opencode.json`:
+
+| Shortcut | Action |
+|----------|--------|
+| `ctrl+a` | Move to line start |
+| `ctrl+e` | Move to line end |
+| `ctrl+w` | Delete word backward |
+| `ctrl+u` | Delete to line start |
+| `ctrl+k` | Delete to line end |
+| `ctrl+b` | Move backward one character |
+| `ctrl+f` | Move forward one character |
+| `alt+b` | Move backward one word |
+| `alt+f` | Move forward one word |
+
+## Platform-Specific Configuration
+
+### Windows Terminal
+
+Users may need to manually configure escape sequence handling for `Shift+Enter` functionality.
+
+Add to Windows Terminal `settings.json`:
+
+```json
+{
+  "actions": [
+    {
+      "command": {
+        "action": "sendInput",
+        "input": "\u001b[13;2u"
+      },
+      "keys": "shift+enter"
+    }
+  ]
+}
+```
+
+## Custom Keybind Examples
+
+### Minimal Configuration
+
+```json
+{
+  "keybinds": {
+    "submit": "ctrl+enter",
+    "cancel": "ctrl+c"
+  }
+}
+```
+
+### Vim-Style Configuration
+
+```json
+{
+  "keybinds": {
+    "leader": "space",
+    "session_new": "<leader>n",
+    "session_list": "<leader>b"
+  }
+}
+```
+
+## Full Keybind Reference
+
+OpenCode provides 80+ configurable actions. Use `/help` or check the documentation for the complete list.
+
+## Best Practices
+
+1. **Keep leader key default**: `ctrl+x` avoids most conflicts
+2. **Test in your terminal**: Some terminals intercept certain key combinations
+3. **Document custom bindings**: Keep a reference for team consistency

moai_adk/templates/.claude/skills/moai-tool-opencode/modules/configure/lsp-servers.md

@@ -0,0 +1,156 @@
+---
+source: https://opencode.ai/docs/lsp/
+fetched: 2026-01-08
+title: LSP Servers Configuration
+---
+
+# LSP Servers Documentation
+
+## Overview
+
+OpenCode integrates Language Server Protocol (LSP) functionality to help LLMs interact with codebases through diagnostic feedback. The platform supports numerous built-in LSP servers across popular programming languages.
+
+## Key Features
+
+### Automatic Detection
+
+LSP servers activate when:
+- File extensions matching supported languages are detected
+- Server requirements are met (runtime, dependencies)
+
+### Built-in Support
+
+OpenCode includes 25+ LSP servers:
+
+| Language | LSP Server |
+|----------|------------|
+| TypeScript/JavaScript | TypeScript Language Server |
+| Python | Pyright |
+| Rust | rust-analyzer |
+| Go | gopls |
+| PHP | Intelephense |
+| C/C++ | clangd |
+| Java | Eclipse JDT LS |
+| Ruby | Solargraph |
+| Swift | SourceKit-LSP |
+| Kotlin | Kotlin Language Server |
+| Scala | Metals |
+| Elixir | ElixirLS |
+| Lua | lua-language-server |
+| Zig | zls |
+| And more... | |
+
+## Configuration Options
+
+Configure LSP behavior in `opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "lsp": {
+    "typescript": {
+      "disabled": false,
+      "command": ["typescript-language-server", "--stdio"],
+      "extensions": [".ts", ".tsx", ".js", ".jsx"],
+      "env": {
+        "NODE_ENV": "development"
+      },
+      "initialization": {
+        "preferences": {
+          "includeCompletionsForModuleExports": true
+        }
+      }
+    }
+  }
+}
+```
+
+### Configuration Properties
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `disabled` | boolean | Turn off specific server |
+| `command` | string[] | Custom startup command |
+| `extensions` | string[] | Associated file types |
+| `env` | object | Environment variables |
+| `initialization` | object | LSP initialization parameters |
+
+## Disabling LSP
+
+### Disable All LSP Servers
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "lsp": false
+}
+```
+
+### Disable Specific Server
+
+```json
+{
+  "lsp": {
+    "typescript": {
+      "disabled": true
+    }
+  }
+}
+```
+
+## Custom LSP Server
+
+Add custom LSP servers:
+
+```json
+{
+  "lsp": {
+    "custom-lsp": {
+      "command": ["custom-lsp-server", "--stdio"],
+      "extensions": [".custom", ".cst"]
+    }
+  }
+}
+```
+
+## Special Configurations
+
+### PHP Intelephense Premium
+
+Supports premium licensing through key files:
+
+| Platform | License Path |
+|----------|--------------|
+| Unix/Linux/macOS | `~/intelephense/licence.txt` |
+| Windows | `%USERPROFILE%\intelephense\licence.txt` |
+
+### Pyright Configuration
+
+```json
+{
+  "lsp": {
+    "pyright": {
+      "initialization": {
+        "python": {
+          "analysis": {
+            "typeCheckingMode": "strict"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `OPENCODE_DISABLE_LSP_DOWNLOAD` | Prevents automatic server installations |
+
+## Best Practices
+
+1. **Let auto-detection work**: Most servers activate automatically
+2. **Disable unused servers**: Reduce resource usage
+3. **Configure per-project**: Use project-level config for specific needs
+4. **Check requirements**: Ensure language runtimes are installed