Skip to main content
Glama

json_schema

Generate TypeScript schema definitions from JSON files or URLs to validate data structures and reduce context size in LLM applications.

Instructions

Generate TypeScript schema for a JSON file or remote JSON URL. Provide the file path or HTTP/HTTPS URL as the only parameter.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYesJSON file path (local) or HTTP/HTTPS URL to generate schema from

Implementation Reference

  • Core handler function that ingests JSON content via strategy pattern and generates TypeScript schema using quicktype library.
    async function processJsonSchema(input: JsonSchemaInput): Promise<JsonSchemaResult> {
      try {
        // Use strategy pattern to ingest JSON content
        const ingestionResult = await jsonIngestionContext.ingest(input.filePath);
        
        if (!ingestionResult.success) {
          // Map strategy errors to existing error format for backward compatibility
          return {
            success: false,
            error: ingestionResult.error
          };
        }
    
        const jsonContent = ingestionResult.content;
    
        // Calculate file size in bytes
        const fileSizeBytes = new TextEncoder().encode(jsonContent).length;
    
        // Generate schema using quicktype with fixed parameters
        try {
          const result = await quicktypeJSON(
            "typescript", 
            "GeneratedType", 
            jsonContent
          );
          
          return {
            success: true,
            schema: result.lines.join('\n'),
            fileSizeBytes
          };
        } catch (error) {
          return {
            success: false,
            error: {
              type: 'quicktype_error',
              message: 'Failed to generate schema',
              details: error
            }
          };
        }
      } catch (error) {
        return {
          success: false,
          error: {
            type: 'validation_error',
            message: 'Unexpected error during processing',
            details: error
          }
        };
      }
    }
  • Zod input schema for validating the filePath parameter supporting local files and HTTP/HTTPS URLs.
    const JsonSchemaInputSchema = z.object({
      filePath: z.string().min(1, "File path or HTTP/HTTPS URL is required").refine(
        (val) => val.length > 0 && (val.startsWith('./') || val.startsWith('/') || val.startsWith('http://') || val.startsWith('https://') || !val.includes('/')),
        "Must be a valid file path or HTTP/HTTPS URL"
      )
    });
  • src/index.ts:507-561 (registration)
    MCP server tool registration for 'json_schema', including input schema, description, and handler that validates input and calls processJsonSchema.
    server.tool(
        "json_schema",
        "Generate TypeScript schema for a JSON file or remote JSON URL. Provide the file path or HTTP/HTTPS URL as the only parameter.",
        {
            filePath: z.string().describe("JSON file path (local) or HTTP/HTTPS URL to generate schema from")
        },
        async ({ filePath }) => {
            try {
                const validatedInput = JsonSchemaInputSchema.parse({
                    filePath: filePath
                });
                const result = await processJsonSchema(validatedInput);
                
                if (result.success) {
                    // Format file size for display
                    const formatFileSize = (bytes: number): string => {
                        if (bytes < 1024) return `${bytes} bytes`;
                        if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
                        return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
                    };
    
                    const fileSizeInfo = `// File size: ${formatFileSize(result.fileSizeBytes)} (${result.fileSizeBytes} bytes)\n\n`;
                    
                    return {
                        content: [
                            {
                                type: "text",
                                text: fileSizeInfo + result.schema
                            }
                        ]
                    };
                } else {
                    return {
                        content: [
                            {
                                type: "text",
                                text: `Error: ${result.error.message}`
                            }
                        ],
                        isError: true
                    };
                }
            } catch (error) {
                return {
                    content: [
                        {
                            type: "text",
                            text: `Validation error: ${error instanceof Error ? error.message : String(error)}`
                        }
                    ],
                    isError: true
                };
            }
        }
    );
  • Type definitions for input, error, and result of json_schema tool.
    type JsonSchemaInput = z.infer<typeof JsonSchemaInputSchema>;
    type JsonFilterInput = z.infer<typeof JsonFilterInputSchema>;
    type JsonDryRunInput = z.infer<typeof JsonDryRunInputSchema>;
    type Shape = { [key: string]: true | Shape };
    
    // Define error types (extended to support new ingestion strategies and edge cases)
    interface JsonSchemaError {
      readonly type: 'file_not_found' | 'invalid_json' | 'network_error' | 'invalid_url' | 'unsupported_content_type' | 'rate_limit_exceeded' | 'validation_error' | 'authentication_required' | 'server_error' | 'content_too_large' | 'quicktype_error';
      readonly message: string;
      readonly details?: unknown;
    }
    
    // Result type for better type safety
    type JsonSchemaResult = {
      readonly success: true;
      readonly schema: string;
      readonly fileSizeBytes: number;
    } | {
      readonly success: false;
      readonly error: JsonSchemaError;
    };
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the tool generates a TypeScript schema, but does not describe how it handles errors (e.g., invalid JSON, network issues), what the output format looks like, or any performance or security considerations, leaving significant gaps for a tool that processes external data.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that is front-loaded with the core purpose and includes essential usage details without any redundant or unnecessary information, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (processing external JSON data), lack of annotations, and no output schema, the description is incomplete. It fails to address critical aspects such as error handling, output format, or security implications, which are necessary for safe and effective use by an AI agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already fully documents the single parameter. The description adds minimal value by restating the parameter's purpose ('file path or HTTP/HTTPS URL') without providing additional syntax, format details, or constraints beyond what the schema specifies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Generate TypeScript schema') and the resource ('JSON file or remote JSON URL'), distinguishing it from sibling tools like json_dry_run and json_filter by focusing on schema generation rather than validation or filtering operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by specifying the input type ('JSON file or remote JSON URL'), but it does not explicitly state when to use this tool versus alternatives like json_dry_run or json_filter, nor does it provide any exclusions or prerequisites for usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kehvinbehvin/json-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server