Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Weaviate

Scalekit connector
Open markdown

The Weaviate connector lets your AI agent act in each user's Weaviate account. Each user connects their own Weaviate access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 25 tools.

Tools
25
What they doRead · write · destructive
15 · 8 · 215 read8 write2 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Weaviate connection

    In AgentKit > Connections, create a Weaviate connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'weaviate'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Weaviate:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'weaviate_collection_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Weaviate credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • weaviate_collection_getGet the definition of one Weaviate collection (class).Read-only

    Get Collection

    Get the definition of one Weaviate collection (class). Returns its name, description, properties (name, dataType, tokenization, index flags), vectorizer and vectorConfig, module config, and multi-tenancy, replication and sharding settings. Use weaviate_collection_get to see the properties you can return or filter on. Use weaviate_collection_list to find collection names.

    Inputs

    collectionstringrequired
    Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
  • weaviate_collection_listList every collection (class) defined in the Weaviate schema.Read-only

    List Collections

    List every collection (class) defined in the Weaviate schema. Returns a classes array; each entry has the collection name, description, properties with data types, vectorizer and vector index settings, and multi-tenancy and replication config. Use weaviate_collection_list to discover collection and property names. Use weaviate_collection_get for one collection's definition.

    Inputs

    This tool takes no inputs.

  • weaviate_collection_object_countCount the objects in a Weaviate collection, optionally only those that match a filter.Read-only

    Count Collection Objects

    Count the objects in a Weaviate collection, optionally only those that match a filter. Returns data.Aggregate.<Collection>[0].meta.count, plus an errors array if the query failed. Use weaviate_collection_object_count to size a collection or a filtered subset. Use weaviate_object_list to read the objects themselves.

    Inputs

    collectionstringrequired
    Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
    tenantstring
    Tenant to count in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
    where_filterstring
    Optional filter, written as a GraphQL where object literal (not JSON: operator values are unquoted). It sets path (property name array), operator (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, Like, ContainsAny, ContainsAll, IsNull, And, Or) and a typed value field such as valueText, valueInt, valueNumber, valueBoolean or valueDate; And/Or take an operands list. Example: {path: ["wordCount"], operator: GreaterThan, valueInt: 1000}.
  • weaviate_collection_shard_listList the shards of a Weaviate collection with their status.Read-only

    List Collection Shards

    List the shards of a Weaviate collection with their status. Returns each shard's name, status (READY or READONLY), per-node status and vector queue size. It does not return vector indexing status. Use weaviate_collection_shard_list to check whether a collection is writable. Use weaviate_node_list with verbose output for vector indexing status and per-node object counts.

    Inputs

    collectionstringrequired
    Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
    tenantstring
    For a multi-tenant collection, the tenant whose shard to show; leave blank to list all shards. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
  • weaviate_graphql_queryRun any Weaviate GraphQL query: Get (with nearText, nearVector, nearObject, hybrid, bm25, where, sort, groupBy), Aggregate, or Explore.Read-only

    Run GraphQL Query

    Run any Weaviate GraphQL query: Get (with nearText, nearVector, nearObject, hybrid, bm25, where, sort, groupBy), Aggregate, or Explore. Weaviate's GraphQL API is read-only. Returns the GraphQL response: data keyed by Get, Aggregate or Explore, plus an errors array if the query failed (often with HTTP 200). Use weaviate_graphql_query for queries the other tools do not cover, such as nearVector, groupBy, sorting, aggregations by property or cross-reference fields. Use weaviate_object_search_hybrid, weaviate_object_search_near_text or weaviate_object_search_bm25 for ordinary searches.

    Inputs

    querystringrequired
    The GraphQL query text. Collection names are used as field names under Get or Aggregate. Example: { Get { Article(nearVector: {vector: [0.1, 0.2, 0.3]}, limit: 5) { title _additional { id distance } } } }.
    operation_namestring
    Name of the operation to run when the query text defines several. Example: ArticleSearch.
    variablesobject
    Values for variables declared in the query, keyed by variable name. Example: {"limit": 5}.
  • weaviate_meta_getGet metadata about the connected Weaviate instance.Read-only

    Get Instance Metadata

    Get metadata about the connected Weaviate instance. Returns the hostname, Weaviate version, and the enabled modules (vectorizers, generative and reranker modules) with their versions. Use weaviate_meta_get to check the server version or which vectorizer modules are available before creating a collection. Use weaviate_node_list for node health and object counts.

    Inputs

    This tool takes no inputs.

  • weaviate_node_listList the nodes of the Weaviate cluster with their status.Read-only

    List Nodes

    List the nodes of the Weaviate cluster with their status. Returns each node's name, status (HEALTHY, UNHEALTHY, UNAVAILABLE), version, git hash and statistics; with output=verbose also each shard, its collection and object count. Use weaviate_node_list to check cluster health or how many objects each shard holds. Use weaviate_meta_get for the server version and modules.

    Inputs

    outputstring
    Detail level: minimal (node status only) or verbose (also per-shard statistics such as object counts). Defaults to minimal. Example: verbose.one of minimalverbosedefault minimal
  • weaviate_object_getGet one Weaviate object by collection and UUID.Read-only

    Get Object

    Get one Weaviate object by collection and UUID. Returns the object's id, class, properties, tenant, creation and update times, and its vector(s) when include=vector. Use weaviate_object_get when you know the object's id. Use weaviate_object_list or a search tool to find ids.

    Inputs

    collectionstringrequired
    Name of the collection the object belongs to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
    object_idstringrequired
    UUID of the object, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
    consistency_levelstring
    How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM.one of ONEQUORUMALL
    includestring
    Extra fields to include, comma-separated: vector (the object's vector or named vectors), classification, featureProjection. Example: vector.
    tenantstring
    Tenant the object belongs to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.