list-schemas
Retrieve all schemas registered in the Schema Registry. Filter results by latest versions, subject prefixes, or deleted schemas to manage schema organization and compliance effectively.
Instructions
List all schemas in the Schema Registry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| baseUrl | No | The base URL of the Schema Registry REST API. | |
| deleted | No | List deleted schemas. | |
| latestOnly | No | If true, only return the latest version of each schema. | |
| subjectPrefix | No | The prefix of the subject to list schemas for. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"baseUrl": {
"default": "",
"description": "The base URL of the Schema Registry REST API.",
"format": "uri",
"type": "string"
},
"deleted": {
"description": "List deleted schemas.",
"type": "string"
},
"latestOnly": {
"default": true,
"description": "If true, only return the latest version of each schema.",
"type": "boolean"
},
"subjectPrefix": {
"description": "The prefix of the subject to list schemas for.",
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- The ListSchemasHandler class implements the core logic for the 'list-schemas' tool, handling Schema Registry interactions to list schemas with optional filtering and versioning.export class ListSchemasHandler extends BaseToolHandler { async handle( clientManager: ClientManager, toolArguments: Record<string, unknown>, ): Promise<CallToolResult> { const { latestOnly, subjectPrefix, deleted } = listSchemasArguments.parse(toolArguments); logger.debug( { latestOnly, subjectPrefix, deleted, }, "ListSchemasHandler.handle called with arguments", ); const registry: SchemaRegistryClient = clientManager.getSchemaRegistryClient(); try { let subjects: string[] = await registry.getAllSubjects(); logger.debug( { subjectsCount: subjects.length }, "Fetched all subjects from registry", ); if (subjectPrefix) { subjects = subjects.filter((s) => s.startsWith(subjectPrefix)); logger.debug( { filteredSubjectsCount: subjects.length, subjectPrefix }, "Filtered subjects by prefix", ); } const result: Record<string, unknown> = {}; for (const subject of subjects) { if (latestOnly) { try { const latest = await registry.getLatestSchemaMetadata(subject); logger.debug({ subject, latest }, "Fetched latest schema metadata"); result[subject] = { version: latest.version, id: latest.id, schemaType: latest.schemaType, schema: latest.schema, }; } catch (err) { logger.warn( { subject, error: err instanceof Error ? err.message : String(err), }, "Failed to fetch latest schema metadata", ); result[subject] = { error: err instanceof Error ? err.message : String(err), }; } } else { try { const versions: number[] = await registry.getAllVersions(subject); logger.debug({ subject, versions }, "Fetched all schema versions"); result[subject] = []; const versionPromises = versions.map(async (version) => { try { const schema = await registry.getSchemaMetadata( subject, version, deleted, ); logger.debug( { subject, version, schema }, "Fetched schema metadata for version", ); (result[subject] as unknown[]).push({ version: schema.version, id: schema.id, schemaType: schema.schemaType, schema: schema.schema, }); } catch (err) { logger.warn( { subject, version, error: err instanceof Error ? err.message : String(err), }, "Failed to fetch schema metadata for version", ); (result[subject] as unknown[]).push({ version, error: err instanceof Error ? err.message : String(err), }); } }); await Promise.all(versionPromises); } catch (err) { logger.warn( { subject, error: err instanceof Error ? err.message : String(err), }, "Failed to fetch all versions for subject", ); result[subject] = { error: err instanceof Error ? err.message : String(err), }; } } } logger.info( { subjects: Object.keys(result).length }, "Returning schema listing result", ); return this.createResponse(JSON.stringify(result)); } catch (error) { logger.error( { error: error instanceof Error ? error.message : JSON.stringify(error), }, "Failed to list schemas", ); return this.createResponse( `Failed to list schemas: ${error instanceof Error ? error.message : JSON.stringify(error)}`, true, ); } } getToolConfig(): ToolConfig { return { name: ToolName.LIST_SCHEMAS, description: "List all schemas in the Schema Registry.", inputSchema: listSchemasArguments.shape, }; } getRequiredEnvVars(): EnvVar[] { return [ "SCHEMA_REGISTRY_ENDPOINT", "SCHEMA_REGISTRY_API_KEY", "SCHEMA_REGISTRY_API_SECRET", ]; } }
- Input schema validation using Zod for the list-schemas tool parameters.const listSchemasArguments = z.object({ latestOnly: z .boolean() .describe("If true, only return the latest version of each schema.") .default(true) .optional(), subjectPrefix: z .string() .describe("The prefix of the subject to list schemas for.") .optional(), deleted: z .boolean() .describe("List deleted schemas. (Only used if latestOnly is false)") .default(false) .optional(), });
- src/confluent/tools/tool-factory.ts:66-66 (registration)Registration of the list-schemas tool handler in the ToolFactory map.[ToolName.LIST_SCHEMAS, new ListSchemasHandler()],
- Enum constant defining the tool name 'list-schemas'.LIST_SCHEMAS = "list-schemas",