json-yaml-schema 0.2.0

Convert JSON API responses to YAML schema

JSON to YAML Schema Converter

A powerful Python tool that converts JSON API responses into YAML schema format with proper type definitions, titles, and format specifications.

Features

• ✅ Smart Type Detection: Automatically detects and maps JSON types to schema types
• ✅ Date-Time Recognition: Identifies datetime strings and adds format: date-time
• ✅ Nested Object Support: Handles complex nested JSON structures
• ✅ Array Processing: Properly processes arrays and their item types
• ✅ Title Generation: Creates human-readable titles from JSON keys
• ✅ CLI Interface: Easy-to-use command-line interface
• ✅ Batch Processing: Convert multiple JSON files at once

Your api response file should look like this e.g

All json file should be build/output inside the folder or response would be like below

[
    {
        "id": 12345,
        "name": "test Innovations Corp",
        "legal_name": "Tech Innovations Corporation Inc.",
        "founded_date": "2020-01-15",
        "incorporation_date": "2020-01-15T09:00:00Z",
        "tax_id": "12-3456789",
        "website": "https://testinnovations.com",
        "industry": "Software Technology",
        "employee_count": 250,
        "annual_revenue": 15000000.75,
        "is_public": true,
        "stock_symbol": null
    },
    {
        "id": 4565,
        "name": "demo Innovations Corp",
        "legal_name": "demo Innovations Corporation Inc.",
        "founded_date": "2020-01-15",
        "incorporation_date": "2020-01-15T09:00:00Z",
        "tax_id": "12-3456789",
        "website": "https://testinnovations.com",
        "industry": "Software Technology",
        "employee_count": 250,
        "annual_revenue": 15000000.75,
        "is_public": true,
        "stock_symbol": null
    },
]

Command Line Interface (CLI)

# Use custom input folder
json2yaml_schema --folder my_api_data_folder

Python API Usage

from json_yaml_schema import JSONToYAMLConverter

# Initialize converter
converter = JSONToYAMLConverter("path/to/json/files")

# Convert all JSON files
converted_files = converter.process_all_json_files()

MCP Server Integration (Copilot / Claude Desktop)

This package includes a Model Context Protocol (MCP) server, allowing AI assistants like GitHub Copilot or Claude Desktop to automatically use this schema converter.

Prerequisites: You must have Python 3.10 or higher installed.

1. Install with MCP Support

Create a virtual environment with Python 3.10+ and install the package:

python3.10 -m venv mcp_env
source mcp_env/bin/activate
pip install -e .

2. Configure Copilot / Claude Desktop

Add the MCP server to your AI assistant's configuration file (e.g., github-copilot.json, claude_desktop_config.json, or via the UI settings for custom MCP servers).

{
  "mcpServers": {
    "json-yaml-schema-converter": {
      "command": "/absolute/path/to/your/mcp_env/bin/json2yaml-mcp-server",
      "args": []
    }
  }
}

Note: Replace /absolute/path/to/your/mcp_env/bin/json2yaml-mcp-server with the actual absolute path to where you installed the environment.

3. Usage

Once configured, you can simply ask your AI assistant:

"create a json yaml file for all the json files in the output folder/ your folder name"

The AI will automatically invoke the convert_json_to_yaml_schema tool and process your JSON files.