Skip to main content

MCP tool for creating lightweight JSON skeletons from large JSON files

Project description

JSON Skeleton MCP Server

A lightweight MCP (Model Context Protocol) server that creates compact "skeleton" representations of large JSON files, helping you understand JSON structure without the full data payload.

Features

  • Lightweight JSON Skeleton: Preserves structure with truncated string values
  • Configurable String Length: Customize max string length (default: 200 chars)
  • Type-Only Mode: Ultra-compact output showing only data types
  • Smart Array Deduplication: Keeps only unique DTO structures in arrays
  • Efficient Processing: Handles massive JSON files that exceed AI model context limits

Installation

Quick Start with uvx (Recommended)

You can run the MCP server directly without installation using uvx:

# Run from GitHub
uvx --from git+https://github.com/jskorlol/json-skeleton-mcp.git json-skeleton

# Run from local directory
uvx --from /path/to/json-skeleton-mcp json-skeleton

Traditional Installation

  1. Clone this repository:
git clone https://github.com/jskorlol/json-skeleton-mcp.git
cd json-skeleton-mcp
  1. Create a virtual environment and install:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .

Usage

As MCP Server in Claude Desktop

Add to your Claude Desktop configuration:

Using uvx (Recommended):

{
  "mcpServers": {
    "json-skeleton": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/jskorlol/json-skeleton-mcp.git", "json-skeleton"]
    }
  }
}

Using local installation:

{
  "mcpServers": {
    "json-skeleton": {
      "command": "uvx",
      "args": ["--from", "/path/to/json-skeleton-mcp", "json-skeleton"]
    }
  }
}

Available Tool

json_skeleton

Creates a lightweight skeleton of a JSON file with the following parameters:

  • file_path (required): Path to the JSON file to process
  • max_length (optional, default: 200): Maximum length for string values
  • type_only (optional, default: false): Return only value types instead of values (most compact output)

Example 1: Basic Usage

Input: json_skeleton(file_path="/path/to/data.json")
Output: Truncated JSON with strings limited to 200 characters

Example 2: Custom String Length

Input: json_skeleton(file_path="/path/to/data.json", max_length=50)
Output: More aggressively truncated JSON with 50-char limit

Example 3: Type-Only Mode (Most Compact)

Input: json_skeleton(file_path="/path/to/data.json", type_only=true)
Output: 
{
  "name": "str",
  "age": "int",
  "active": "bool",
  "balance": "float",
  "notes": "null",
  "items": [
    {
      "id": "int",
      "label": "str"
    }
  ]
}

Programmatic Usage

from json_skeleton import SkeletonGenerator

# Initialize generator
generator = SkeletonGenerator(max_value_length=200)

# Process a file
result = generator.process_file("large_data.json")
print(result['skeleton'])

# Process with custom length
result = generator.process_file("large_data.json", max_length=50)
print(result['skeleton'])

# Process in type-only mode
result = generator.process_file("large_data.json", type_only=True)
print(result['skeleton'])

# Or process data directly
data = {"key": "very long value" * 50, "items": [1, 2, 3, 1, 2, 3]}
skeleton = generator.create_skeleton(data)
print(skeleton)

How It Works

Array Deduplication

The tool intelligently deduplicates array items by comparing their DTO (Data Transfer Object) structure:

  • For primitive arrays: Keeps up to 3 unique values
  • For object arrays: Keeps one example of each unique structure
  • Structure comparison is based on keys and value types, not actual values
  • In type-only mode: Shows only the type of the first array element

Value Processing

  • Normal Mode: Strings longer than max_length are truncated with "...(truncated)" suffix
  • Type-Only Mode: All values replaced with their type names (str, int, float, bool, null)
  • Numbers, booleans, and nulls are preserved as-is in normal mode

Use Cases

  1. Understanding API Responses: Quickly grasp the structure of large API responses without processing megabytes of data
  2. Documentation: Generate structure examples for API documentation
  3. Development: Work with data structure without handling large payloads
  4. Token Optimization: Reduce token usage when working with AI models
  5. Schema Discovery: Use type-only mode to understand data types in complex JSON structures

Testing

Run the test scripts to see the tool in action:

# Test basic functionality
python test_skeleton.py

# Test with different max_length values
python test_max_length.py

# Test type-only mode
python test_type_only.py

Requirements

  • Python 3.10+
  • MCP library

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_json_skeleton_mcp-0.1.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_json_skeleton_mcp-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_json_skeleton_mcp-0.1.0.tar.gz.

File metadata

File hashes

Hashes for iflow_mcp_json_skeleton_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0170ba7148ba98343faa2167e23ff73f553d01968adc74d5b1374b72db4b2fb9
MD5 083af13fa37ce4b0b05620a33fc5951f
BLAKE2b-256 e9c6af1e530d3eedfb05a1b0888192adf63a7e0e3f5574d73fadf16af38f54e7

See more details on using hashes here.

File details

Details for the file iflow_mcp_json_skeleton_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_json_skeleton_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b8ae37b825078382b4cacd287f5d2d5de04c5ab44f3bbfe8caaa74e88e06d18
MD5 3af78248732234bf4d0cac73771d2851
BLAKE2b-256 debbb59742f06c27bf1318c3c328e757fe23d527717e54eb538d2d76552f5f50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page