MCP Server Typescript

🚀 TypeScript SDK Usage Guide

This TypeScript SDK simplifies the integration of MCP services, offering a straightforward way to build servers and handle requests.

🚀 Quick Start

Here is a simple example demonstrating how to use the SDK:

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { StdioServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new StdioServerTransport();
await server.connect(transport);

✨ Features

• Easy Integration: Seamlessly integrate with MCP services.
• Flexible Request Handling: Customize request handlers for different scenarios.
• Multiple Transport Options: Support various transport mechanisms.

📦 Installation

To install the MCP TypeScript SDK, follow these steps:

Install via npm

npm install @modelcontextprotocol/typescript-sdk

Other Platforms

For installation on other platforms (e.g., Yarn, pnpm), refer to the documentation of the corresponding package manager.

💻 Usage Examples

Basic Usage

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { StdioServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new StdioServerTransport();
await server.connect(transport);

Advanced Usage

Low-level Implementation

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { RawServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new RawServerTransport();
await server.connect(transport);

TypeScript Type Definitions

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { z } from "zod";

type User = {
  id: string;
  name: string;
  email: string;
};

const userSchema = z.object({
  id: z.string().min(1),
  name: z.string().min(1),
  email: z.string().email()
});

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("user", async ({ body }) => {
  const user = await body.validate(userSchema);
  return {
    user
  };
});

Complex Example

import { Server } from "@modelcontextprotocol/typescript-sdk";
import sqlite3 from "sqlite3";
import { promisify } from "util";
import { z } from "zod";

const server = new Server({
  name: "SQLite Explorer",
  version: "1.0.0"
});

const getDb = () => {
  const db = new sqlite3.Database("database.db");
  return {
    all: promisify(db.all.bind(db)),
    close: promisify(db.close.bind(db))
  };
};

server.setRequestHandler("schema", async () => {
  const db = getDb();
  try {
    const tables = await db.all(
      "SELECT sql FROM sqlite_master WHERE type='table'"
    );
    return {
      contents: [{
        uri: "schema://main",
        text: tables.map((t: {sql: string}) => t.sql).join("\n")
      }]
    };
  } finally {
    await db.close();
  }
});

server.setRequestHandler("query", async ({ body }) => {
  const sql = body.text;
  const db = getDb();
  try {
    const results = await db.all(sql);
    return {
      content: [{
        type: "text",
        text: JSON.stringify(results, null, 2)
      }]
    };
  } catch (err: unknown) {
    const error = err as Error;
    return {
      content: [{
        type: "text",
        text: `Error: ${error.message}`
      }],
      status: "error"
    };
  } finally {
    await db.close();
  }
});

const transport = new StdioServerTransport();
await server.connect(transport);

📚 Documentation

For more information, refer to the following links:

• Official Documentation
• GitHub Repository

📄 License

This project is licensed under the MIT License:

MIT License

Copyright (c) 2023 Example Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.