أداة MCP

عرض مفاتيح API

sosoapi_list_api_keys

عرض مفاتيح API للمستخدم (الاسم وآخر 4 أحرف والحالة والانتهاء والتسلسل)؛ اضبط include_authority لإمكانات كل مفتاح وحد مساحة عمله. لا تُعاد الأسرار. يلزم Manage API keys؛ لا يتاح لـ PAT.

اقرأ بصيغة Markdown

الملفات التعريفية ووسائل النقل

الملفات التعريفية: full · وسائل النقل: stdio, http

اختر core أو full للأدوات التي يراها عميلك؛ لا يغيّر ذلك أذوناته. يحتاج رفع الملفات المحلية stdio ولا يتاح بـ HTTP. اضبط SOSOAPI_OUTPUT_SCHEMAS=1 لمخططات المخرجات بالاكتشاف. النتائج منظّمة بهذا الإعداد أوبدونه.

الأذونات والآثار الجانبية

تساعد الشروح العملاء على وصف الأداة. يظل كل استدعاء يفحص مصادقة المستخدم ودوره ووصوله إلى المورد وتفويض الإمكانات.

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

/identity-api/api-keys/list: agent:manage_api_keys · synchronous_http_response

حقول الإدخال

تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.

حقول الإدخال
الحقل / الفرع	النوع / مطلوب	القيود
`$`	`object`مطلوب في العنصر الأب	`additionalProperties: false`
`include_revoked`	`boolean`اختياري / عنصر	—
`include_authority`	`boolean`اختياري / عنصر	إرجاع إمكانات كل مفتاح وحد مساحة العمل (null = كل مساحة عمل) والتفويض الذي أنشأه أيضاً. —

مخطط JSON Schema الكامل

{
  "type": "object",
  "properties": {
    "include_revoked": {
      "type": "boolean"
    },
    "include_authority": {
      "description": "Also return each key's capabilities, Workspace limit (null = every Workspace) and the delegated grant that created it.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

مخرجات منظّمة

يصف المخطط structuredContent في نتيجة أداة ناجحة. تشمل استجابة MCP أيضاً content وقد تضبط isError عند الفشل. للنشر، اقرأ النتيجة النهائية بدلاً من اعتبار القبول أوالنص تأكيداً. تشرح عملية API المرتبطة الأذونات وقواعد المحاولة.

مخرجات منظّمة
الحقل / الفرع	النوع / مطلوب	القيود
`$`	`object`مطلوب في العنصر الأب	`additionalProperties: false`
`apiKeys`	`array`مطلوب في العنصر الأب	—
`apiKeys[]`	`object`اختياري / عنصر	`additionalProperties: false`
`apiKeys[].id`	`string`مطلوب في العنصر الأب	`format: "uuid"`
`apiKeys[].name`	`string`مطلوب في العنصر الأب	—
`apiKeys[].last_4`	`string`مطلوب في العنصر الأب	—
`apiKeys[].scopes`	`array`مطلوب في العنصر الأب	—
`apiKeys[].scopes[]`	`string`اختياري / عنصر	—
`apiKeys[].created_at`	`string`مطلوب في العنصر الأب	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`apiKeys[].expires_at`	`string \| null`مطلوب في العنصر الأب	—
`apiKeys[].expires_at`anyOf 1	`string`مطلوب في العنصر الأب	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`apiKeys[].expires_at`anyOf 2	`null`مطلوب في العنصر الأب	—
`apiKeys[].last_used_at`	`string \| null`مطلوب في العنصر الأب	—
`apiKeys[].last_used_at`anyOf 1	`string`مطلوب في العنصر الأب	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`apiKeys[].last_used_at`anyOf 2	`null`مطلوب في العنصر الأب	—
`apiKeys[].revoked_at`	`string \| null`مطلوب في العنصر الأب	—
`apiKeys[].revoked_at`anyOf 1	`string`مطلوب في العنصر الأب	`format: "date-time"` `pattern: "^(?:(?:\\d\\d[2468][048]\|\\d\\d[13579][26]\|\\d\\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\\d\|30)\|(?:02)-(?:0[1-9]\|1\\d\|2[0-8])))T(?:(?:[01]\\d\|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z\|([+-](?:[01]\\d\|2[0-3]):[0-5]\\d)))$"`
`apiKeys[].revoked_at`anyOf 2	`null`مطلوب في العنصر الأب	—
`apiKeys[].status`	`string`مطلوب في العنصر الأب	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`	`object \| null`مطلوب في العنصر الأب	—
`apiKeys[].replaces`anyOf 1	`object`مطلوب في العنصر الأب	`additionalProperties: false`
`apiKeys[].replaces.id`anyOf 1	`string`مطلوب في العنصر الأب	`format: "uuid"`
`apiKeys[].replaces.name`anyOf 1	`string`مطلوب في العنصر الأب	—
`apiKeys[].replaces.last_4`anyOf 1	`string`مطلوب في العنصر الأب	—
`apiKeys[].replaces.status`anyOf 1	`string`مطلوب في العنصر الأب	`enum: ["active","expired","revoked"]`
`apiKeys[].replaces`anyOf 2	`null`مطلوب في العنصر الأب	—
`apiKeys[].replaced_by`	`array`مطلوب في العنصر الأب	—
`apiKeys[].replaced_by[]`	`object`اختياري / عنصر	`additionalProperties: false`
`apiKeys[].replaced_by[].id`	`string`مطلوب في العنصر الأب	`format: "uuid"`
`apiKeys[].replaced_by[].name`	`string`مطلوب في العنصر الأب	—
`apiKeys[].replaced_by[].last_4`	`string`مطلوب في العنصر الأب	—
`apiKeys[].replaced_by[].status`	`string`مطلوب في العنصر الأب	`enum: ["active","expired","revoked"]`
`apiKeys[].capabilities`	`array`اختياري / عنصر	—
`apiKeys[].capabilities[]`	`string`اختياري / عنصر	`enum: ["agent:operate","agent:publish","agent:engage"]`
`apiKeys[].workspace_ids`	`array \| null`اختياري / عنصر	—
`apiKeys[].workspace_ids`anyOf 1	`array`اختياري / عنصر	—
`apiKeys[].workspace_ids[]`anyOf 1	`string`اختياري / عنصر	`format: "uuid"`
`apiKeys[].workspace_ids`anyOf 2	`null`اختياري / عنصر	—
`apiKeys[].created_by_delegated_grant_id`	`string \| null`اختياري / عنصر	—
`apiKeys[].created_by_delegated_grant_id`anyOf 1	`string`اختياري / عنصر	`format: "uuid"`
`apiKeys[].created_by_delegated_grant_id`anyOf 2	`null`اختياري / عنصر	—

مخطط JSON Schema الكامل

{
  "type": "object",
  "properties": {
    "apiKeys": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "last_4": {
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_used_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "revoked_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "expired",
              "revoked"
            ]
          },
          "replaces": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string"
                  },
                  "last_4": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "active",
                      "expired",
                      "revoked"
                    ]
                  }
                },
                "required": [
                  "id",
                  "name",
                  "last_4",
                  "status"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "replaced_by": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "uuid"
                },
                "name": {
                  "type": "string"
                },
                "last_4": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "active",
                    "expired",
                    "revoked"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "last_4",
                "status"
              ],
              "additionalProperties": false
            }
          },
          "capabilities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "agent:operate",
                "agent:publish",
                "agent:engage"
              ]
            }
          },
          "workspace_ids": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "created_by_delegated_grant_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "last_4",
          "scopes",
          "created_at",
          "expires_at",
          "last_used_at",
          "revoked_at",
          "status",
          "replaces",
          "replaced_by"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "apiKeys"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

مثال لاستدعاء أداة

تستخدم الأمثلة قيماً خيالية مفحوصة بالمخططات. استبدل المعرّفات بالمفوّض لك، والوسائط بأصول جاهزة، والتواريخ بوقت نشر مؤكد. افحص أهلية الحساب قبل الكتابة. لا تُرسل الصفحة طلبات API.

{
  "name": "sosoapi_list_api_keys",
  "arguments": {}
}

structuredContent

{
  "apiKeys": []
}

/identity-api/api-keys/list

تثبيت MCP أو ربطه