Joeblockchain MCP Server Client

🚀 MCP Server-Client Example

This project demonstrates the basic implementation of the Model Context Protocol (MCP) using the TypeScript SDK. It includes a server that provides resource access and a client that connects to the server and requests resources, with both communicating via stdio transport.

🚀 Quick Start

Prerequisites

• Node.js (v16 or higher)
• npm

Installation

Clone the repository and install the dependencies:

npm install

Running the Example

You need to run the server and client in two separate terminal windows.

1. Start the server:

npm run start:server

2. Start the client in a new terminal:

npm run start:client

The client will perform the following actions:

1. Connect to the server.
2. Request a list of available resources.
3. Read the content of an example resource.

✨ Features

Server Features

The current server supports the following features:

• Resource listing
• Resource reading
• Basic error handling (for unknown resources)

Available Resources

The example server provides access to the following resources:

• file:///example.txt: A simple text resource

📦 Installation

Clone the repository and install the dependencies:

npm install

💻 Usage Examples

Basic Usage

You need to run the server and client in two separate terminal windows.

1. Start the server:

npm run start:server

2. Start the client in a new terminal:

npm run start:client

Advanced Usage

To add new resources, modify the ListResourcesRequestSchema handler in src/index.ts:

server.setRequestHandler(ListResourcesRequestSchema, async () => {
  return {
    resources: [
      {
        uri: "file:///example.txt",
        name: "Example Resource",
      },
      // Add new resources here
    ],
  };
});

📚 Documentation

Project Structure

src/
  ├── index.ts    # Server implementation
  └── client.ts   # Client implementation

Development

Scripts

• npm run start:server: Start the MCP server.
• npm run start:client: Start the MCP client.

Adding New Resources

To add new resources, modify the ListResourcesRequestSchema handler in src/index.ts as shown in the advanced usage example above.

🔧 Technical Details

Dependencies

• @modelcontextprotocol/sdk: MCP TypeScript SDK
• ts-node: TypeScript execution environment
• typescript: TypeScript compiler

📄 License

ISC