Skip to main content
Glama
ricleedo

JSON MCP Boilerplate

by ricleedo

MCP Server Boilerplate

A starter template for building MCP (Model Context Protocol) servers. This boilerplate provides a clean foundation for creating your own MCP server that can integrate with Claude, Cursor, or other MCP-compatible AI assistants.

Purpose

This boilerplate helps you quickly start building:

  • Custom tools for AI assistants

  • Resource providers for dynamic content

  • Prompt templates for common operations

  • Integration points for external APIs and services

Related MCP server: MCP Server Boilerplate

Features

  • Simple "hello-world" tool example

  • TypeScript support with proper type definitions

  • Easy installation scripts for different MCP clients

  • Clean project structure ready for customization

How It Works

This MCP server template provides:

  1. A basic server setup using the MCP SDK

  2. Example tool implementation

  3. Build and installation scripts

  4. TypeScript configuration for development

The included example demonstrates how to create a simple tool that takes a name parameter and returns a greeting.

Getting Started

# Clone the boilerplate
git clone <your-repo-url>
cd mcp-server-boilerplate

# Install dependencies
pnpm install

# Build the project
pnpm run build

# Start the server
pnpm start

Installation Scripts

This boilerplate includes convenient installation scripts for different MCP clients:

# For Claude Desktop
pnpm run install-desktop

# For Cursor
pnpm run install-cursor

# For Claude Code
pnpm run install-code

# Generic installation
pnpm run install-server

These scripts will build the project and automatically update the appropriate configuration files.

Usage with Claude Desktop

The installation script will automatically add the configuration, but you can also manually add it to your claude_desktop_config.json file:

{
  "mcpServers": {
    "your-server-name": {
      "command": "node",
      "args": ["/path/to/your/dist/index.js"]
    }
  }
}

Then restart Claude Desktop to connect to the server.

Customizing Your Server

Adding Tools

Tools are functions that the AI assistant can call. Here's the basic structure:

server.tool(
  "tool-name",
  "Description of what the tool does",
  {
    // Zod schema for parameters
    param1: z.string().describe("Description of parameter"),
    param2: z.number().optional().describe("Optional parameter"),
  },
  async ({ param1, param2 }) => {
    // Your tool logic here
    return {
      content: [
        {
          type: "text",
          text: "Your response",
        },
      ],
    };
  }
);

Adding Resources

Resources provide dynamic content that the AI can access:

server.resource(
  "resource://example/{id}",
  "Description of the resource",
  async (uri) => {
    // Extract parameters from URI
    const id = uri.path.split("/").pop();

    return {
      contents: [
        {
          uri,
          mimeType: "text/plain",
          text: `Content for ${id}`,
        },
      ],
    };
  }
);

Adding Prompts

Prompts are reusable templates:

server.prompt(
  "prompt-name",
  "Description of the prompt",
  {
    // Parameters for the prompt
    topic: z.string().describe("The topic to discuss"),
  },
  async ({ topic }) => {
    return {
      description: `A prompt about ${topic}`,
      messages: [
        {
          role: "user",
          content: {
            type: "text",
            text: `Please help me with ${topic}`,
          },
        },
      ],
    };
  }
);

Project Structure

├── src/
│   └── index.ts          # Main server implementation
├── scripts/              # Installation and utility scripts
├── dist/                 # Compiled JavaScript (generated)
├── package.json          # Project configuration
├── tsconfig.json         # TypeScript configuration
└── README.md            # This file

Development

  1. Make changes to src/index.ts

  2. Run pnpm run build to compile

  3. Test your server with pnpm start

  4. Use the installation scripts to update your MCP client configuration

Next Steps

  1. Update package.json with your project details

  2. Customize the server name and tools in src/index.ts

  3. Add your own tools, resources, and prompts

  4. Integrate with external APIs or databases as needed

License

MIT

Available Tools

2 tools
json_extractA

Extract specific data using paths, filters, patterns, or slices from JSON files. Always use this tool when you need to retrieve particular values, filter arrays/objects by conditions, search for patterns, or slice data. Ideal for targeted data extraction, data transformation, and focused analysis of specific JSON elements.

ParametersJSON Schema
NameRequiredDescriptionDefault
file_pathYesPath to the JSON file
pathNoDot notation path to target
filterNoJS condition to filter results (e.g., 'item.age > 18')
patternNoRegex pattern to search for
search_typeNoWhat to search when using pattern
startNoArray slice start index
endNoArray slice end index
keysNoSpecific object keys to extract
default_valueNoFallback if path not found

TDQS

A4/5.0
Behavior3/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It describes what the tool does (extract data using various methods) and mentions use cases (data transformation, focused analysis), but doesn't address important behavioral aspects like error handling, performance characteristics, memory usage with large files, or what happens when multiple extraction methods are combined. It provides basic operational context but lacks depth on behavioral traits.

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

Conciseness4/5

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

The description is appropriately sized with three sentences that each serve distinct purposes: stating the core functionality, providing usage guidelines, and describing ideal use cases. It's front-loaded with the main purpose and avoids redundancy. While efficient, it could be slightly more structured with clearer separation between mandatory and optional parameter usage.

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

Completeness3/5

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

For a tool with 9 parameters, no annotations, and no output schema, the description provides adequate but incomplete context. It covers the 'what' and 'when' well but lacks details on 'how' the extraction works, error conditions, return formats, or performance considerations. The description compensates somewhat for the lack of annotations by specifying use cases, but doesn't fully address the complexity of a multi-parameter extraction tool.

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 schema already documents all 9 parameters thoroughly. The description mentions the extraction methods (paths, filters, patterns, slices) which correspond to parameters, but doesn't add meaningful semantic context beyond what's in the schema descriptions. It doesn't explain how parameters interact or provide usage examples. Baseline 3 is appropriate when schema does the heavy lifting.

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 tool's purpose as extracting specific data from JSON files using multiple methods (paths, filters, patterns, slices). It distinguishes from the sibling 'json_read' by emphasizing targeted extraction rather than general reading. The verb 'extract' with the resource 'JSON files' is specific and actionable.

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use this tool: 'Always use this tool when you need to retrieve particular values, filter arrays/objects by conditions, search for patterns, or slice data.' It also distinguishes from the sibling 'json_read' by specifying this is for 'targeted data extraction' rather than general reading. The 'Ideal for' section further clarifies appropriate contexts.

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

json_readA

Read and analyze JSON. Always use this tool to explore JSON structure, understand data schema, or get high-level overviews of large JSON. Use this for initial data exploration or when you need to understand the shape and types of data before extracting specific values.

ParametersJSON Schema
NameRequiredDescriptionDefault
file_pathYesPath to the JSON file
pathNoDot notation to specific location
max_depthNoLimit traversal depth
max_keysNoMaximum number of keys to show per object (default: show all keys)
sample_arraysNoShow only first N array items
keys_onlyNoReturn only the key structure
include_typesNoAdd type information
include_statsNoAdd file size and structure statistics

TDQS

A4.4/5.0
Behavior4/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 effectively communicates that this is a read/analysis tool (not destructive), provides context about its exploratory nature, and hints at capabilities like handling large JSON files and providing overviews. However, it doesn't mention potential limitations like file size constraints or performance characteristics.

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 perfectly structured with two sentences that each earn their place. The first sentence establishes the core purpose, while the second provides specific usage guidelines. There's zero wasted language and it's appropriately sized for the tool's complexity.

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

Completeness4/5

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

Given the tool's moderate complexity (8 parameters, no output schema, no annotations), the description provides excellent guidance on when and why to use it. However, without annotations or output schema, it could benefit from more explicit information about what the tool returns (e.g., formatted analysis vs. raw data) and any behavioral constraints.

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?

The schema description coverage is 100%, so the schema already documents all 8 parameters thoroughly. The description doesn't add any parameter-specific information beyond what's in the schema, maintaining the baseline score of 3 for high schema coverage.

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 tool's purpose with specific verbs ('read and analyze JSON') and resources ('JSON structure', 'data schema', 'large JSON'). It distinguishes from the sibling tool json_extract by emphasizing exploration and understanding rather than extraction.

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

Usage Guidelines5/5

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

The description explicitly states when to use this tool ('Always use this tool to explore JSON structure', 'for initial data exploration', 'when you need to understand the shape and types of data before extracting specific values') and implies when not to use it (when you need to extract specific values, suggesting json_extract as an alternative).

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 2 tool updatesv1.0.0
    • Changedjson_extract2 fields changed
      • addedInput schema / $schema
        Added value: +"http://json-schema.org/draft-07/schema#"
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedjson_read2 fields changed
      • addedInput schema / $schema
        Added value: +"http://json-schema.org/draft-07/schema#"
      • addedInput schema / additionalProperties
        Added value: +false
  2. 2 tool updates
    • First observedjson_extract
    • First observedjson_read

TDQS

A3.9/5.0
Disambiguation5/5

The two tools have clearly distinct purposes: json_extract is for targeted data extraction and transformation, while json_read is for initial exploration and schema understanding. Their descriptions explicitly guide when to use each, eliminating any ambiguity or overlap in functionality.

Naming Consistency5/5

Both tools follow a consistent verb_noun pattern (json_extract and json_read) with the same prefix 'json_' and clear action verbs. This predictable naming makes it easy for agents to understand and select the appropriate tool.

Tool Count2/5

With only two tools, the server feels too thin for a JSON processing domain, lacking essential operations like json_write, json_validate, or json_transform. While the tools cover reading and extraction, the scope is incomplete for typical JSON workflows, making it borderline inadequate.

Completeness2/5

The tool surface has significant gaps: it supports reading and extraction but lacks write, update, validation, or advanced transformation capabilities. This incomplete coverage will likely cause agent failures when tasks require modifying or validating JSON data, limiting practical utility.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    D
    maintenance
    A starter template for building MCP servers with TypeScript support, example tools, and automated installation scripts for Claude Desktop, Cursor, and other MCP-compatible AI assistants. Provides a foundation for creating custom tools, resource providers, and prompt templates.
    16
    -
  • F
    license
    C
    quality
    D
    maintenance
    A starter template for building MCP (Model Context Protocol) servers that integrate with Claude, Cursor, or other MCP-compatible AI assistants. Provides a clean foundation with TypeScript support, example tool implementation, and installation scripts for quick customization.
    2
    0
    -
  • F
    license
    C
    quality
    D
    maintenance
    A starter template for building custom MCP (Model Context Protocol) servers that can integrate with Claude, Cursor, or other MCP-compatible AI assistants. Provides a clean foundation with TypeScript support, example implementations, and installation scripts for quickly creating custom tools, resources, and prompts.
    2
    0
    -
  • F
    license
    C
    quality
    D
    maintenance
    A starter template for building custom MCP servers that can integrate with Claude, Cursor, or other MCP-compatible AI assistants. Provides a clean foundation with TypeScript support, example implementations, and easy installation scripts for quickly creating tools, resources, and prompt templates.
    2
    0
    -

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/ricleedo/JSON-MCP-Boilerplate'

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