MCP Ts Starter

🚀 Hello MCP World Server

A simple Model Context Protocol (MCP) server implemented in TypeScript. This server demonstrates basic MCP functionality, including resources, prompts, and tools.

✨ Features

• Support for SSE and STDIO transports
• Handling of static and dynamic resources
• Example prompt implementation
• Example tool for echoing messages
• Debugging tool for server introspection

🚀 Quick Start

Prerequisites

• Node.js (v16 or higher)
• npm or yarn

📦 Installation

npm install

Build

npm run build

Run the Server

HTTP/SSE Transport (Web Browser)

npm run start:http

This command starts the server at http://localhost:3000, including:

• SSE endpoint at /sse
• Message endpoint at /messages

STDIO Transport (Command Line)

npm run start

This command runs the server in stdio mode, suitable for command-line integration.

💻 Usage Examples

Test the Server with cURL

1. Start the HTTP server:

   npm run start:http
   

2. In one terminal window, connect to the SSE endpoint:

   curl -N http://localhost:3000/sse
   

   You should see a response similar to the following:

   event: endpoint
   data: /messages?sessionId=YOUR_SESSION_ID
   

3. In another terminal window, send a request to invoke the echo tool:

   curl -X POST \
     "http://localhost:3000/messages?sessionId=YOUR_SESSION_ID" \
     -H 'Content-Type: application/json' \
     -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/invoke",
       "params": {
         "name": "echo",
         "parameters": {
           "message": "Testing the MCP server!"
         }
       }
     }'
   

4. You should see a response similar to the following in the SSE terminal window:

   event: message
   data: {"jsonrpc":"2.0","id":1,"result":{"content":[{"type":"text","text":"Hello Testing the MCP server!"}]}}
   

5. Use the debug tool to view all available server methods:

   curl -X POST \
     "http://localhost:3000/messages?sessionId=YOUR_SESSION_ID" \
     -H 'Content-Type: application/json' \
     -d '{
       "jsonrpc": "2.0",
       "id": 2,
       "method": "tools/invoke",
       "params": {
         "name": "debug",
         "parameters": {}
       }
     }'
   

Test the Server with the MCP Inspector

To get a visual interface, you can use the MCP Inspector tool:

1. Connect to http://localhost:3000/sse in the MCP Inspector.
2. Available resources and tools.
3. Interactively invoke tools.

📚 Documentation

Resources

• hello://world - A static "Hello, World" resource
• greeting://{name} - A dynamic greeting with a name parameter

Tools

• echo - Echo a message and prepend "Hello"
• debug - List all available tools and methods

Prompts

None.

Troubleshooting

None.

📄 License

None.