> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# تسجيل أداة

> تسجيل أداة في سجل أدوات MAIP مع متطلبات النطاق، وتصنيف المخاطر، وحدود المعدل

# تسجيل أداة

`POST /v1/tools`

يسجل أداة جديدة في سجل أدوات MAIP الخاص بالمستأجر. تمثل الأدوات قدرات خارجية (واجهات برمجة التطبيقات، الوظائف، الخدمات) يمكن لوكلاء الآلة استدعاؤها. ترتبط كل أداة بنطاق مطلوب ومستوى مخاطر وبوابة موافقة اختيارية.

ترفع المنصة تلقائيًا مستوى المخاطر إلى `"high"` إذا كان اسم الأداة أو النطاق المطلوب يحتوي على أفعال خطيرة (كتابة، حذف، إرسال، تنفيذ، نشر، تدمير، إسقاط، اقتطاع).

> [!NOTE]
>
> يجب أن تكون أسماء الأدوات فريدة لكل مستأجر. محاولة تسجيل أداة باسم
> اسم موجود بالفعل يُرجع `409 Conflict`.

### المصادقة

يتطلب رأس `X-API-Key` أو رمز Bearer JWT. يتم اشتقاق مساحة العمل من بيانات الاعتماد الموثقة؛ لا ترسل `X-Tenant-ID`.

### الاستجابة

**id** `string`

معرف UUID للأداة المسجلة حديثًا.

**tenant\_id** `string`

معرف UUID للمستأجر المالك.

**name** `string`

اسم الأداة القابل للقراءة آليًا.

**display\_name** `string`

اسم الأداة المقروء بشريًا.

**description** `string`

وصف الأداة.

**scope\_required** `string`

النطاق المطلوب للاستدعاء.

**risk\_level** `string`

تصنيف المخاطر الفعال (قد يتم رفعه تلقائيًا).

**requires\_approval** `boolean`

ما إذا كانت الموافقة البشرية مطلوبة.

**rate\_limit\_per\_minute** `integer`

حد المعدل لكل وكيل.

**category** `string`

فئة الأداة.

**status** `string`

حالة الأداة. دائمًا `"active"` عند الإنشاء.

**metadata** `object`

بيانات تعريف الأداة.

**created\_at** `string`

طابع زمني لإنشاء ISO 8601.

**updated\_at** `string`

طابع زمني لآخر تحديث ISO 8601.

### مثال

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/tools \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "search.web",
    "display_name": "Web Search",
    "description": "Performs web searches via SerpAPI and returns structured results",
    "scope_required": "tool:search.web",
    "risk_level": "low",
    "rate_limit_per_minute": 30,
    "category": "search",
    "metadata": {
      "endpoint_url": "https://serpapi.com/search",
      "auth_type": "api_key",
      "max_results": 10
    }
  }'
```

***

### الرفع التلقائي لمستوى المخاطر

تقوم المنصة بفحص أسماء الأدوات ومتطلبات النطاق بحثًا عن أفعال خطيرة. إذا تم اكتشافها، يتم رفع مستوى المخاطر تلقائيًا:

| الفعل المكتشف | الرفع التلقائي |
| - | - |
| `write`، `delete`، `send` | تم الرفع إلى `"high"` |
| `execute`، `deploy`، `destroy` | تم الرفع إلى `"high"` |
| `drop`، `truncate` | تم الرفع إلى `"high"` |

تتطلب الأدوات ذات مستوى المخاطر `"critical"` دائمًا موافقة بشرية بغض النظر عن إعداد `requires_approval`.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/tools
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/tools:
    post:
      tags:
        - Machine Identity
      summary: تسجيل أداة
      description: >-
        يسجل أداة قابلة للاستدعاء يمكن للوكلاء استدعاؤها. يحدد مخطط الأداة وسائط
        الإدخال المتوقعة باستخدام مخطط JSON.
      operationId: maip.tools.register
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                category:
                  type: string
                description:
                  type: string
                  description: وصف أداة مقروء بشريًا
                display_name:
                  type: string
                metadata: {}
                name:
                  type: string
                  description: اسم أداة فريد
                rate_limit_per_minute:
                  type: integer
                requires_approval:
                  type: boolean
                risk_level:
                  type: string
                scope_required:
                  type: string
              type: object
              required:
                - name
                - display_name
                - scope_required
      responses:
        '201':
          description: الأداة مسجلة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipTool'
        '400':
          description: خطأ في التحقق
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: تجاوز حد المعدل
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipTool:
      type: object
      properties:
        tool_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        schema:
          type: object
          additionalProperties: true
        agent_id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: رمز خطأ قابل للقراءة آليًا
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: رسالة خطأ مقروءة بشريًا
        http_status:
          type: integer
          description: رمز حالة HTTP
        retry_after_ms:
          type: integer
          description: عدد المللي ثانية للانتظار قبل إعادة المحاولة (لحدود المعدل)
        details:
          type: object
          description: سياق خطأ إضافي
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.