connector-read

Run a READ-ONLY query for the ACTUAL ROWS of an OM-synced/Wexa DB source, LIVE against the source (nothing is copied into Wexa — ideal for large warehouse/DB sources). Use this ONLY for data/rows. For the shape of the source (which tables/collections exist and their fields), do NOT call this — read it from the ontology graph instead (fast, no live call): the connector's tables are Table nodes carrying name + fields. FIRST get a connectorId from the ontology with query-context: MATCH (t:Table) WHERE t.liveReadable = true AND t.connectorId IS NOT NULL RETURN t.name, t.connectorId, t.serviceType, t.readAction, t.fields (or DataService for source-level). ONLY use a connectorId from a node where liveReadable=true — nodes without connectorId are OM-crawled metadata and are NOT live-readable (passing one yields "invalid connector id"). Then call this with that connectorId + a query you formed from that shape: SQL → 'sql' (read-only SELECT) or 'table'; Mongo → 'table' + 'filter'/'aggregate', or 'list_collections'. Write/CRUD actions are blocked.

What it is called on each surface

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

Surface	Name
Wexa MCP server	`connector-read`
REST API	`POST /v1/connector-read`
TypeScript SDK	`fabric.connectorRead()`
Python SDK	`fabric.connector_read()`

Arguments

Every argument is optional: connector-read answers a bare call.

Argument	Type	Required	Notes
`action`	string	Optional	ActionDef name of a READ action, e.g. "linear.get_issues". Use for connectors with synced read actions.
`aggregate`	array	Optional	Mongo read-only aggregation stages (with 'table' = collection), e.g. [{"$group":{"_id":"$siteId","posts":{"$sum":1}}}]. Write stages ($out/$merge) are rejected.
`connectorId`	string	Optional	Connector id of the DB source (from the ontology DataService/Table node). Enables on-the-fly read when the source has no ActionDef.
`filter`	object	Optional	Optional Mongo find filter.
`limit`	integer	Optional	Max rows (default 100, hard cap 10000).
`list_collections`	boolean	Optional	Mongo: list the source's collection names (on-the-fly discovery of the source shape, no row data).
`params`	object	Optional	Action parameters for an ActionDef read (e.g. table_name, filters, limit)
`sql`	string	Optional	A single read-only SELECT you formed from the project ontology (SQL sources). Writes are rejected.
`table`	string	Optional	Table/collection to read when not passing raw sql (returns SELECT * / find with a limit).

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.

What it returns

The three surfaces wrap this differently, and code written against one will not read another correctly — see return shape.

The shape of result for connector-read is not recorded here: it was not captured against a live deployment. Call it once and read what comes back rather than assuming a shape.

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: they resolve against the project the documentation is written against, so the call runs as written once you point it at your own deployment. Swap them for the ids of your own objects.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "connector-read",
    "arguments": {
      "action": "list_collections"
    }
  }
}

curl -sS https://fabric.wexa.ai/v1/connector-read \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"action":"list_collections"}'

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

const fabric = new Fabric()
const { result } = await fabric.connectorRead({
  action: "list_collections"
})

from wexa import Fabric

fabric = Fabric()
out = fabric.connector_read(action="list_collections")

Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its HTTP status second. connector-read checks the fabric:query.read grant, and reaches the seven classes every tool reaches — listed under the common set. These are the ones specific to it:

Error	Status	Raised when
`NotFound`	404	`connectorId` matches no connector wired to this project.
`ConfigurationError`	5xx	`connector-read` is not available to you. Retrying will not help.

Governance

Every call to connector-read runs through the same ten-stage lifecycle as every other Wexa tool: the credential is resolved to a scope, the fabric:query.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.

connector-read 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.