d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
61 lines
1.8 KiB
TypeScript
61 lines
1.8 KiB
TypeScript
import type { ConvexListTablesParams, ConvexListTablesResponse } from '@/tools/convex/types'
|
|
import { convexApiUrl, convexAuthHeaders, parseConvexResponse } from '@/tools/convex/utils'
|
|
import type { ToolConfig } from '@/tools/types'
|
|
|
|
export const listTablesTool: ToolConfig<ConvexListTablesParams, ConvexListTablesResponse> = {
|
|
id: 'convex_list_tables',
|
|
name: 'Convex List Tables',
|
|
description:
|
|
'List all tables in a Convex deployment along with their JSON schemas. Requires streaming export, available on Convex paid plans.',
|
|
version: '1.0.0',
|
|
|
|
params: {
|
|
deploymentUrl: {
|
|
type: 'string',
|
|
required: true,
|
|
visibility: 'user-only',
|
|
description: 'Convex deployment URL (e.g., https://your-deployment.convex.cloud)',
|
|
},
|
|
deployKey: {
|
|
type: 'string',
|
|
required: true,
|
|
visibility: 'user-only',
|
|
description: 'Convex deploy key from the dashboard Settings page',
|
|
},
|
|
},
|
|
|
|
request: {
|
|
url: (params) => convexApiUrl(params.deploymentUrl, '/api/json_schemas?format=json'),
|
|
method: 'GET',
|
|
headers: (params) => convexAuthHeaders(params.deployKey),
|
|
},
|
|
|
|
transformResponse: async (response: Response) => {
|
|
const data = await parseConvexResponse(response)
|
|
const schemas =
|
|
data !== null && typeof data === 'object' && !Array.isArray(data)
|
|
? (data as Record<string, unknown>)
|
|
: {}
|
|
|
|
return {
|
|
success: true,
|
|
output: {
|
|
tables: Object.keys(schemas).sort(),
|
|
schemas,
|
|
},
|
|
}
|
|
},
|
|
|
|
outputs: {
|
|
tables: {
|
|
type: 'array',
|
|
description: 'Names of the tables in the deployment',
|
|
items: { type: 'string' },
|
|
},
|
|
schemas: {
|
|
type: 'json',
|
|
description: 'Map of table name to the JSON schema of its documents',
|
|
},
|
|
},
|
|
}
|