> Source: https://wexa.ai/docs/tools/list-connectors

# list-connectors

List the connectors this project may use. Each connector comes with its actions, and each action comes
with the JSON Schema of its arguments. Use it to find out how to call an action, not only that it exists.

Which connectors you see is decided by the access scope that was chosen when each connector was
provisioned:

| Access scope | You see the connector when |
| --- | --- |
| `organization` | your project is in the connector's organization |
| `department` | your project is in the connector's department |
| `project` | your project is the project the connector was provisioned in |
| `individual` | you are the person who provisioned it |

Thus two callers in the same project can see different lists. A connector from another organization
never appears. A connector that was provisioned before access scopes existed reads as `organization`.
A connector can appear although it was provisioned in a different project: `home_project_id` tells you
which project that was.

Only actions that can run appear. Provisioning a connector mints one skill for each enabled action, and a
disabled action has no skill, so it is not listed.

## What it is called on each surface

The wire name is `list-connectors` everywhere: it is what the Wexa MCP server advertises, the REST path is
`POST /v1/list-connectors`, and each SDK exposes it under its own language's naming convention.

| Surface | Name |
| --- | --- |
| Wexa MCP server | `list-connectors` |
| REST API | `POST /v1/list-connectors` |
| TypeScript SDK | `fabric.listConnectors()` |
| Python SDK | `fabric.list_connectors()` |

## Arguments

Every argument is optional: `list-connectors` answers a bare call.

| Argument | Type | Required | Notes |
| --- | --- | --- | --- |
| `connector_id` | string | Optional | Optional: return only this connector. |

`project_id`, `projectID`, `organization_id` and `executed_by` are not arguments you pass: the
platform binds all four from the credential you authenticated with, and both SDKs refuse them
before the request leaves your process — see
[server-bound arguments](/docs/get-started/scope-and-server-bound-arguments).

## What it returns

Each connector has these fields:

| Field | What it is |
| --- | --- |
| `connector_id` | The id to pass to other connector tools. |
| `name`, `category` | The connector's name and its type, for example `duckduckgo`. |
| `home_project_id` | The project the connector was provisioned in. |
| `access_scope`, `access_scope_id` | The access scope, and the department when the scope is `department`. |
| `actions` | The actions you can run. Each has a `name`, a `title`, a `description` and an `input_schema`. |

An action's `input_schema` is JSON Schema. Its property names are the argument names the action takes.

The three surfaces wrap this differently, and code written against one will not read another
correctly — see [return shape](/docs/tools/overview#return-shape).

A real response, captured from a live call to `list-connectors` with `connector_id` set:

**Result of list-connectors**

**REST API**

```json
{
  "lifecycle_id": "qlc_000008",
  "result": {
    "connectors": [
      {
        "connector_id": "6aa0fc7d19a6e73abca9352d",
        "name": "DuckDuckGo",
        "category": "duckduckgo",
        "status": "ready",
        "description": "DuckDuckGo Instant Answer API connector for quick answers like abstracts, related topics, and more.",
        "home_project_id": "6aa0fa95a832af2fd9633045",
        "access_scope": "organization",
        "actions": [
          {
            "name": "search",
            "title": "Search",
            "description": "Search DuckDuckGo Instant Answer API and return abstract and related topics.",
            "input_schema": {
              "properties": {
                "no_html": {
                  "description": "Strip HTML from text",
                  "title": "Strip HTML",
                  "type": "boolean"
                },
                "no_redirect": {
                  "description": "Disable HTTP redirects",
                  "title": "No Redirect",
                  "type": "boolean"
                },
                "query": {
                  "description": "The search query",
                  "title": "Query",
                  "type": "string"
                },
                "skip_disambig": {
                  "description": "Skip disambiguation results",
                  "title": "Skip Disambiguation",
                  "type": "boolean"
                }
              },
              "required": [
                "query"
              ],
              "type": "object"
            }
          }
        ]
      }
    ],
    "total": 1
  }
}
```

**Wexa MCP server**

```json
{
  "content": [
    {
      "text": "{\"lifecycle_id\":\"qlc_000009\",\"result\":{\"connectors\":[{\"connector_id\":\"6aa0fc7d19a6e73abca9352d\",\"name\":\"DuckDuckGo\",\"category\":\"duckduckgo\",\"status\":\"ready\",\"description\":\"DuckDuckGo Instant Answer API connector for quick answers like abstracts, related topics, and more.\",\"home_project_id\":\"6aa0fa95a832af2fd9633045\",\"access_scope\":\"organization\",\"actions\":[{\"name\":\"search\",\"title\":\"Search\",\"description\":\"Search DuckDuckGo Instant Answer API and return abstract and related topics.\",\"input_schema\":{\"properties\":{\"no_html\":{\"description\":\"Strip HTML from text\",\"title\":\"Strip HTML\",\"type\":\"boolean\"},\"no_redirect\":{\"description\":\"Disable HTTP redirects\",\"title\":\"No Redirect\",\"type\":\"boolean\"},\"query\":{\"description\":\"The search query\",\"title\":\"Query\",\"type\":\"string\"},\"skip_disambig\":{\"description\":\"Skip disambiguation results\",\"title\":\"Skip Disambiguation\",\"type\":\"boolean\"}},\"required\":[\"query\"],\"type\":\"object\"}}]}],\"total\":1}}",
      "type": "text"
    }
  ],
  "isError": false
}
```

**TypeScript SDK**

```ts
// the object you get back IS the result — there is no `.result` to read
{
  connectors: [
    {
      connector_id: '6aa0fc7d19a6e73abca9352d',
      name: 'DuckDuckGo',
      category: 'duckduckgo',
      status: 'ready',
      description: 'DuckDuckGo Instant Answer API connector for quick answers like abstracts, related topics, and more.',
      home_project_id: '6aa0fa95a832af2fd9633045',
      access_scope: 'organization',
      actions: [
        {
          name: 'search',
          title: 'Search',
          description: 'Search DuckDuckGo Instant Answer API and return abstract and related topics.',
          input_schema: {
            properties: {
              no_html: {
                description: 'Strip HTML from text',
                title: 'Strip HTML',
                type: 'boolean'
              },
              no_redirect: {
                description: 'Disable HTTP redirects',
                title: 'No Redirect',
                type: 'boolean'
              },
              query: {
                description: 'The search query',
                title: 'Query',
                type: 'string'
              },
              skip_disambig: {
                description: 'Skip disambiguation results',
                title: 'Skip Disambiguation',
                type: 'boolean'
              }
            },
            required: [
              'query'
            ],
            type: 'object'
          }
        }
      ]
    }
  ],
  total: 1
}

// The TS SDK names these camelCase — lifecycleId, traceId — where Python uses
// lifecycle_id and trace_id. Both are non-enumerable: readable, but omitted by
// Object.keys() and JSON.stringify(). `result.lifecycleId` here is undefined.
result.lifecycleId // 'qlc_000008'
```

**Python SDK**

```python
# a dict subclass; `result` is already unwrapped
{
 "connectors": [
  {
   "connector_id": "6aa0fc7d19a6e73abca9352d",
   "name": "DuckDuckGo",
   "category": "duckduckgo",
   "status": "ready",
   "description": "DuckDuckGo Instant Answer API connector for quick answers like abstracts, related topics, and more.",
   "home_project_id": "6aa0fa95a832af2fd9633045",
   "access_scope": "organization",
   "actions": [
    {
     "name": "search",
     "title": "Search",
     "description": "Search DuckDuckGo Instant Answer API and return abstract and related topics.",
     "input_schema": {
      "properties": {
       "no_html": {
        "description": "Strip HTML from text",
        "title": "Strip HTML",
        "type": "boolean"
       },
       "no_redirect": {
        "description": "Disable HTTP redirects",
        "title": "No Redirect",
        "type": "boolean"
       },
       "query": {
        "description": "The search query",
        "title": "Query",
        "type": "string"
       },
       "skip_disambig": {
        "description": "Skip disambiguation results",
        "title": "Skip Disambiguation",
        "type": "boolean"
       }
      },
      "required": [
       "query"
      ],
      "type": "object"
     }
    }
   ]
  }
 ],
 "total": 1
}

out.lifecycle_id  # 'qlc_000008' — an attribute, not a key
```

Keeping the `lifecycle_id` is what lets you ask later why a call was allowed, refused or held.

## Calling it

The same call on all four surfaces. Pick a tab once and every code block in the documentation follows it.

The ids in this example are real, and resolve against the project the documentation is written
against. Swap them for your own. A value in angle brackets is one only you can supply, and the
platform refuses a literal `<...>`.

**Call list-connectors**

**Wexa MCP server**

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list-connectors",
    "arguments": {
      "connector_id": "6aa0fc7d19a6e73abca9352d"
    }
  }
}
```

**REST API**

```bash
curl -sS https://fabric.wexa.ai/v1/list-connectors \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"connector_id":"6aa0fc7d19a6e73abca9352d"}'
```

**TypeScript SDK**

```ts
import { Fabric } from '@wexa-fabric/sdk'

const fabric = new Fabric()
const result = await fabric.listConnectors({
  connector_id: "6aa0fc7d19a6e73abca9352d"
})
```

**Python SDK**

```python
from wexa import Fabric

fabric = Fabric()
out = fabric.list_connectors(connector_id="6aa0fc7d19a6e73abca9352d")
```

## Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its
HTTP status second. `list-connectors` checks the `fabric:orchestrate.read` grant, and reaches the seven classes every
tool reaches — listed under [the common set](/docs/tools/errors#the-common-set). These are the ones specific to it:

| Error | Status | Raised when |
| --- | --- | --- |
| `ConfigurationError` | 5xx | `list-connectors` is not available to you. Retrying will not help. |

## Governance

Every call to `list-connectors` runs through the same ten-stage lifecycle as every other Wexa tool: the
credential is resolved to a scope, the `fabric:orchestrate.read` grant is checked, quota is drawn down, the arguments are
validated, policy rules are evaluated, the call is executed, the result is shaped and redacted, and an audit
record is written. The `lifecycle_id` in the response is the handle to that record.

`list-connectors` only reads, so it is not marked consequential: it is audited lightly and is never held for
approval. It still consumes quota and is still refused by policy like anything else.

## See also

[`run-connector-action`](/docs/tools/run-connector-action) to run an action you found here,
[`list-skills`](/docs/tools/list-skills) for the skill ids an agent uses,
[`provision-connector`](/docs/tools/provision-connector),
[the tool index](/docs/tools/overview), [errors](/docs/tools/errors),
and [which identifier goes where](/docs/tools/identifiers).
