| --- |
| title: الأدوات المخصصة |
| description: أنشئ أدوات يمكن لـ LLM استدعاؤها في opencode. |
| --- |
| |
| الأدوات المخصصة هي دوال تنشئها يمكن لـ LLM استدعاؤها أثناء المحادثات. تعمل جنبا إلى جنب مع [الأدوات المدمجة](/docs/tools) في opencode مثل `read` و`write` و`bash`. |
|
|
| --- |
| |
| |
|
|
| تُعرّف الأدوات كملفات **TypeScript** أو **JavaScript**. لكن تعريف الأداة يمكنه استدعاء سكربتات مكتوبة **بأي لغة** — إذ تُستخدم TypeScript أو JavaScript فقط لتعريف الأداة نفسه. |
|
|
| --- |
| |
| |
|
|
| يمكن تعريفها: |
|
|
| - محليا بوضعها في مجلد `.opencode/tools/` داخل مشروعك. |
| - أو عالميا بوضعها في `~/.config/opencode/tools/`. |
|
|
| --- |
| |
| |
|
|
| أسهل طريقة لإنشاء أدوات هي استخدام المساعد `tool()` الذي يوفر أمان الأنواع والتحقق. |
|
|
| ```ts title=".opencode/tools/database.ts" {1} |
| 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) { |
| // Your database logic here |
| return `Executed query: ${args.query}` |
| }, |
| }) |
| ``` |
|
|
| يصبح **اسم الملف** هو **اسم الأداة**. المثال أعلاه ينشئ أداة باسم `database`. |
|
|
| --- |
| |
| |
|
|
| يمكنك أيضا تصدير عدة أدوات من ملف واحد. يصبح كل تصدير **أداة مستقلة** باسم **`<filename>_<exportname>`**: |
|
|
| ```ts title=".opencode/tools/math.ts" |
| 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 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 args.a * args.b |
| }, |
| }) |
| ``` |
|
|
| ينشئ هذا أداتين: `math_add` و`math_multiply`. |
|
|
| --- |
| |
| |
|
|
| تُصنّف الأدوات المخصصة حسب اسم الأداة. إذا استخدمت أداة مخصصة نفس اسم أداة مدمجة، فإن الأداة المخصصة تأخذ الأولوية. |
|
|
| على سبيل المثال، يستبدل هذا الملف أداة `bash` المدمجة: |
|
|
| ```ts title=".opencode/tools/bash.ts" |
| import { tool } from "@opencode-ai/plugin" |
|
|
| export default tool({ |
| description: "Restricted bash wrapper", |
| args: { |
| command: tool.schema.string(), |
| }, |
| async execute(args) { |
| return `blocked: ${args.command}` |
| }, |
| }) |
| ``` |
|
|
| :::note |
| فضّل استخدام أسماء فريدة ما لم تكن تريد استبدال أداة مدمجة عمدا. إذا كنت تريد تعطيل أداة مدمجة ولكن لا تريد استبدالها، استخدم [الأذونات](/docs/permissions). |
| ::: |
|
|
| --- |
| |
| |
|
|
| يمكنك استخدام `tool.schema`، وهو في الأساس [Zod](https://zod.dev)، لتعريف أنواع الوسائط. |
|
|
| ```ts "tool.schema" |
| args: { |
| query: tool.schema.string().describe("SQL query to execute") |
| } |
| ``` |
|
|
| يمكنك أيضا استيراد [Zod](https://zod.dev) مباشرة وإرجاع كائن عادي: |
|
|
| ```ts {6} |
| import { z } from "zod" |
|
|
| export default { |
| description: "Tool description", |
| args: { |
| param: z.string().describe("Parameter description"), |
| }, |
| async execute(args, context) { |
| // Tool implementation |
| return "result" |
| }, |
| } |
| ``` |
|
|
| --- |
| |
| |
|
|
| تستقبل الأدوات سياقا حول الجلسة الحالية: |
|
|
| ```ts title=".opencode/tools/project.ts" {8} |
| import { tool } from "@opencode-ai/plugin" |
|
|
| export default tool({ |
| description: "Get project information", |
| args: {}, |
| async execute(args, context) { |
| // Access context information |
| const { agent, sessionID, messageID, directory, worktree } = context |
| return `Agent: ${agent}, Session: ${sessionID}, Message: ${messageID}, Directory: ${directory}, Worktree: ${worktree}` |
| }, |
| }) |
| ``` |
|
|
| استخدم `context.directory` لدليل العمل الخاص بالجلسة. |
| استخدم `context.worktree` لجذر شجرة العمل (worktree) في git. |
|
|
| --- |
| |
| |
|
|
| |
|
|
| يمكنك كتابة أدواتك بأي لغة تريدها. إليك مثالا يجمع رقمين باستخدام Python. |
|
|
| أولا، أنشئ الأداة كسكربت Python: |
|
|
| ```python title=".opencode/tools/add.py" |
| import sys |
|
|
| a = int(sys.argv[1]) |
| b = int(sys.argv[2]) |
| print(a + b) |
| ``` |
|
|
| ثم أنشئ تعريف الأداة الذي يستدعيه: |
|
|
| ```ts title=".opencode/tools/python-add.ts" {10} |
| import { tool } from "@opencode-ai/plugin" |
| import path from "path" |
|
|
| export default tool({ |
| description: "Add two numbers using Python", |
| args: { |
| a: tool.schema.number().describe("First number"), |
| b: tool.schema.number().describe("Second number"), |
| }, |
| async execute(args, context) { |
| const script = path.join(context.worktree, ".opencode/tools/add.py") |
| const result = await Bun.$`python3 ${script} ${args.a} ${args.b}`.text() |
| return result.trim() |
| }, |
| }) |
| ``` |
|
|
| هنا نستخدم أداة [`Bun.$`](https://bun.com/docs/runtime/shell) لتشغيل سكربت Python. |
|
|