Boilerplate MCP Server

🚀 Management Boilerplate Model Context Protocol (MCP) Server Implementation in TypeScript

This project provides a TypeScript implementation of the Model Context Protocol (MCP) server. It allows you to quickly set up an MCP server, use its client, and customize the server's functionality.

🚀 Quick Start

📦 Installation

Install this package using the following command:

npm install -y @aashari/boilerplate-mcp-server

💻 Usage Examples

Basic Usage

Create a New MCP Service

1. Initialize a new project:

npx tsx init

2. Add the following content to the src/index.ts file:

import { createServer } from '@aashari/boilerplate-mcp-server';

const server = createServer();

// Add custom functionality
server.getIpDetails.addHandler((context) => {
  return {
    status: 'success',
    country: 'China',
    countryCode: 'CN',
    region: 'BJ',
    regionName: 'Beijing',
    city: 'Beijing',
    zip: '100000',
    lat: '39.9045',
    lon: '116.4074',
    timezone: 'Asia/Shanghai',
    isp: 'China Mobile',
    org: 'China Mobile',
    as: 'AS9009 China Internet Co., Ltd.',
    query: context.ip,
  };
});

server.listen(3000);

3. Run the service:

npm run dev

Use the MCP Client

import { createClient } from '@aashari/boilerplate-mcp-server';

const client = createClient('http://localhost:3000');

// Get the IP details of the current device
client.getIpDetails().then(console.log);

// Get the IP details of a specified IP
client.getIpDetails('8.8.8.8').then(console.log);

Advanced Usage

You can directly use the command-line tool:

• Display help and available commands:

npx -y @aashari/boilerplate-mcp-server --help

Example output:

Usage: @aashari/boilerplate-mcp-server [options] [command]

A basic boilerplate for a Model Context Protocol (MCP) server implemented in TypeScript

Options:
  -V, --version               Output the version number
  -h, --help                  Display help for command

Commands:
  get-ip-details [ipAddress]   Get the details of a specific IP address or the current device
  help [command]              Display help for command

• Get the IP details of the current device:

npx -y @aashari/boilerplate-mcp-server get-ip-details

Example output:

Status: Success
Country: Indonesia
Country Code: ID
Region: JK
Region Name: Jakarta
City: Jakarta
Zip: 11730
Latitude: -6.2114
Longitude: 106.8446
Timezone: Asia/Jakarta
Isp: Biznet Wifi
Org: 
As: AS17451 BIZNET NETWORKS
Query: 118.923.134.234

• Get the IP details of a specified IP:

npx -y @aashari/boilerplate-mcp-server get-ip-details 8.8.8.8

🔧 Configuration

Environment Variables

You can configure the server by setting the following environment variables:

• PORT: Set the port that the service listens on (default value: 3000)

PORT=8080 npm run dev

🛠️ Developer Guide

Customize the MCP Service

You can customize the MCP service by extending the createServer function. For example, add a custom handler:

import { createServer } from '@aashari/boilerplate-mcp-server';

const server = createServer();

server.getIpDetails.addHandler((context) => {
  return {
    status: 'success',
    country: 'China',
    countryCode: 'CN',
    region: 'BJ',
    regionName: 'Beijing',
    city: 'Beijing',
    zip: '100000',
    lat: '39.9045',
    lon: '116.4074',
    timezone: 'Asia/Shanghai',
    isp: 'China Mobile',
    org: 'China Mobile',
    as: 'AS9009 China Internet Co., Ltd.',
    query: context.ip,
  };
});

server.listen(3000);

📄 Project Information

📦 Install Dependencies

To install all dependencies, run:

npm install

📄 License

This project is licensed under the MIT License.

Copyright (c) 2023, aashari.

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.

📋 Command Line Examples

Install the Package

npm install -y @aashari/boilerplate-mcp-server

Run the Service

npx tsx init && npm run dev

Use the Client

import { createClient } from '@aashari/boilerplate-mcp-server';

const client = createClient('http://localhost:3000');

// Get the IP details of the current device
client.getIpDetails().then(console.log);

// Get the IP details of a specified IP
client.getIpDetails('8.8.8.8').then(console.log);

Use the Command-Line Tool

npx -y @aashari/boilerplate-mcp-server get-ip-details 8.8.8.8

📚 Other Resources

• Project Documentation
• Issue Tracking

This documentation covers how to install, configure, and use the @aashari/boilerplate-mcp-server package, including the use of the command-line tool and the implementation of a custom server. We hope it helps you!