> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Weaviate

> Browse Weaviate schema, run GraphQL queries, and read or create objects in a Weaviate cluster

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key comes from `WEAVIATE_API_KEY`.
* **Docs**: [https://docs.weaviate.io/cloud/manage-clusters/connect](https://docs.weaviate.io/cloud/manage-clusters/connect)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable           | Required | Description                                                                                                              |
| ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `WEAVIATE_API_KEY` | Yes      | Weaviate cluster API key (sent as Authorization: Bearer) [Docs](https://docs.weaviate.io/cloud/manage-clusters/connect). |

## Setup

1. **Create a Weaviate Cloud account**: Sign up at [https://console.weaviate.cloud](https://console.weaviate.cloud) - free 14-day sandbox clusters are available for testing. Self-hosted Weaviate with API-key auth enabled works too.
2. **Create a cluster and grab credentials**: Create a cluster, then open Cluster details to copy the REST endpoint URL and an API key (use a read-write key for object creation). The key is only displayed once.
3. **Store the key and note your host**: Add WEAVIATE\_API\_KEY=.... to your .env file. Tools take the cluster host (without https\://) as the clusterHost parameter, e.g. my-cluster-abc123.weaviate.cloud.
4. **Verify access**: Run the Get Schema tool with your clusterHost.

* Every tool needs the clusterHost parameter - there is no global Weaviate API host
* nearText GraphQL queries require a vectorizer module configured on the collection (and possibly a model-provider API key set on the cluster)
* Admin keys can read and write; read-only keys will get 403 on Create Object

Provider API reference: [https://docs.weaviate.io/weaviate/api/rest](https://docs.weaviate.io/weaviate/api/rest)

## Tools

| Tool              | Access | Description                                                                                              |
| ----------------- | ------ | -------------------------------------------------------------------------------------------------------- |
| Get Schema        | Read   | List all collections (classes) and their property definitions                                            |
| Run GraphQL Query | Read   | Run a GraphQL query against the cluster (Get, Aggregate, Explore - including nearText/nearVector search) |
| List Objects      | Read   | List objects, optionally filtered to one collection (class)                                              |
| Get Object        | Read   | Get a single object by collection (class) and ID                                                         |
| Create Object     | Write  | Create a new object in a collection (class)                                                              |

## Example prompts

* Get my Weaviate schema and summarize the collections, their properties, and vectorizers.
* Run a Weaviate GraphQL nearText query against a collection I specify and summarize the top results.