Zaptomcp

🚀 ZapToMCP

ZapToMCP is an implementation based on the Model Context Protocol (MCP), supporting multiple transmission methods. It's an improved version of FastMCP and LiteMCP, suitable for scenarios requiring high performance and scalability.

🚀 Quick Start

📦 Installation

To get started, install the npm package:

npm install @zaptomcp/sdk

💻 Usage Examples

Basic Usage

Server-side

const { Server } = require('@zaptomcp/sdk');

async function main() {
    const server = new Server({
        name: 'test-server',
        version: '1.0.0'
    });

    await server.start();
}

main().catch(console.error);

Client-side

const { Client } = require('@zaptomcp/sdk');

async function main() {
    const client = new Client({
        name: 'test-client',
        version: '1.0.0'
    });

    await client.connect(new HTTPClientTransport('http://localhost:3000'));
}

main().catch(console.error);

✨ Features

ZapToMCP provides a flexible and efficient framework for implementing the Model Context Protocol in various environments. It supports the following features:

• Multiple Transport Protocols: Including in-memory, SSE, standard I/O, and streaming HTTP.
• High-performance Processing: Optimized resource management and data exchange efficiency.
• Easy to Extend: The modular design makes it simple to add new features and transport methods.

📚 Documentation

Project Overview

The project contains the following main parts:

• packages/sdk: The core MCP SDK, providing server and client implementations.
• examples: Example code demonstrating how to use the SDK.
• docs: Project documentation materials.
• scripts: Scripts for project building, testing, and other development tasks.

Development Scripts

The project provides the following npm scripts:

• dev: Run the SDK in development mode.
• build: Build the SDK package.
• test: Run test cases.

For example, execute the following in the SDK directory:

cd packages/sdk && npm run dev

Code Quality

The project uses the following tools to ensure code quality:

• TypeScript: Provides static type checking.
• ESLint and Prettier: Ensure consistent code style.

SDK Package Details

Feature Overview

The SDK provides the following main features:

• Server class: Used to create and manage MCP servers.
• Multiple transport implementations:
  • InMemoryTransport: In-memory transport, suitable for testing environments.
  • SSETransport: Real-time communication based on Server-Sent Events.
  • StdIOTransport: Console mode using standard input and output.
  • StreamableHTTPTransport: An HTTP protocol implementation supporting streaming data transfer.

Installation and Development

To develop on the SDK package, follow these steps:

cd packages/sdk
npm install
npm run dev

Testing

Run test cases:

cd packages/sdk
npm test

🤝 Contribution Guidelines

Any contributions are welcome! Please follow these steps to submit a Pull Request:

1. Fork the repository.
2. Create a feature branch (e.g., feature/amazing-feature).
3. Commit changes using conventional commits (npm run commit).
4. Push to the branch.
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

👏 Acknowledgments

• ZapToMCP is inspired by FastMCP.
• This project implements the open-source standard TypeScript SDK of the Model Context Protocol.
• FastMCP is inspired by Jonathan Lowin's Python implementation fastmcp.
• Part of the code implementation is borrowed from LiteMCP.
• Part of the code implementation refers to the SSE implementation in the Model Context Protocol.

⚠️ Important Note

This repository is under active development. The API and implementation details may change. Use at your own risk.