@openpets/turbopuffer
v1.0.0
Published
Manage Turbopuffer namespaces, run vector/full-text queries, and perform write operations from OpenPets.
Maintainers
Readme
Turbopuffer
OpenPets plugin for Turbopuffer's serverless vector and full-text search API.
Features
- Test Turbopuffer API connectivity and auth
- List namespaces and paginate results
- Fetch namespace metadata (schema, size, index state)
- Run advanced queries using raw JSON payloads
- Run advanced writes (upsert, patch, delete, copy) using raw JSON payloads
- Optional read-only support (write/delete tools are removed automatically)
Configuration
Add the following values to .env:
TURBOPUFFER_API_KEY=tpuf_A1...
TURBOPUFFER_REGION=gcp-us-central1
# Optional override:
# TURBOPUFFER_BASE_URL=https://aws-us-east-1.turbopuffer.comTURBOPUFFER_BASE_URL takes precedence over TURBOPUFFER_REGION.
Tools
turbopuffer-test-connectionturbopuffer-list-namespacesturbopuffer-get-namespace-metadataturbopuffer-query-documentsturbopuffer-write-documentsturbopuffer-delete-namespace
Query Example
Use turbopuffer-query-documents with:
namespace:docs-prodqueryJson:
{
"rank_by": ["id", "asc"],
"top_k": 10,
"include_attributes": ["title", "updated_at"]
}Write Example
Use turbopuffer-write-documents with:
namespace:docs-prodwriteJson:
{
"upsert_rows": [
{ "id": "doc-1", "title": "Hello", "content": "World" }
]
}Validate
From repo root:
pets validate pets/turbopuffer
pets build turbopuffer