# Describe a plugin capability

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

Read plugin capability descriptions and input requirements returned by search.

```text
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-discovery/describe
```

## Before you call this API

Prepare the target Workspace ID and a personal access token that can access the resources and perform this operation. Use the actual resource identifier for `workspace_id` in the path, and also supply the Workspace ID in `X-Workspace-ID`. See [Shared objects and inputs](objects.md#input-identifiers) for environment variable sources.

## Query parameters

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} Request example

```bash
curl -X GET "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-discovery/describe" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  --get \
  --data-urlencode "ref=$CAPABILITY_REF"
```

:::::
:::::{tab-item} Parameters

Read the selected capability's input Schema, connection requirements, or skill path. Describing a capability does not execute it or grant account permissions. Search again on a version conflict; do not rewrite identifiers or digests in the reference.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ref` | string | Yes | capability_ref returned by search; URL-encode its original value. |

:::::
::::::
:::::::

## Successful response

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} Response example

```json
{
  "code": 0,
  "data": {
    "capability": {
      "id": "operation:example",
      "name": "example",
      "description": "示例能力",
      "kind": "http",
      "side_effect": "read",
      "digest": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "capability_ref": "opaque-example",
    "input_schema": {
      "type": "object"
    }
  }
}
```

:::::
:::::{tab-item} Fields

| Field | Type | Description |
| --- | --- | --- |
| `code` | integer | 0 on success. |
| `data` | object | Data returned by this operation. |
| `data.capability` | object | Resource fields; see [Shared objects and states](objects.md). |
| `data.capability_ref` | string | Resource fields; see [Shared objects and states](objects.md). |
| `data.input_schema` | object | Resource fields; see [Shared objects and states](objects.md). |

:::::
::::::
:::::::

## Error responses

Handle numeric business-error `code`, `message`, and `details.reason` separately from authorization-layer string codes. See [Errors and states](objects.md#error-responses). On a state or version conflict, read the current resource first; do not automatically change identifiers or retry writes.
