get-schema
Retrieve database schema details by providing a schema UUID. Supports filtering by fields and inclusion of deleted schemas.
Instructions
Get database schema details by UUID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Database schema UUID | |
| fields | No | ||
| include | No |
Implementation Reference
- src/index.ts:195-195 (registration)Registration of the 'get-schema' tool in the MCP server, using getSchemaSchema for validation and wrapping the getSchema handler.
tool("get-schema", "Get database schema details by UUID", getSchemaSchema.shape, wrapToolHandler(getSchema)); - src/tools/schemas.ts:18-22 (schema)Zod schema defining input validation for get-schema: requires 'id' (UUID), optional 'fields' and 'include'.
export const getSchemaSchema = z.object({ id: z.string().describe("Database schema UUID"), fields: z.string().optional(), include: z.enum(["non-deleted", "deleted", "all"]).optional(), }); - src/tools/schemas.ts:24-27 (handler)Handler function for get-schema: extracts 'id' from params and makes a GET request to /databaseSchemas/{id} with remaining query parameters.
export async function getSchema(params: z.infer<typeof getSchemaSchema>) { const { id, ...query } = params; return omClient.get(`/databaseSchemas/${id}`, query); }