MCP Rest

🚀 MCP REST API Documentation

This is a REST API wrapper built around the Model Context Protocol (MCP) client. It allows you to interact with MCP without maintaining a constant connection. This is for testing purposes only and should not be used in a production environment.

🚀 Quick Start

This REST API wrapper enables interaction with MCP without the need for a persistent connection.

📦 Installation

# Global installation
npm install -g mcp-rest

# Or run with npx
npx mcp-rest

💻 Usage Examples

Basic Usage

npx mcp-rest [options]

Options

Advanced Usage

SSE Mode

# Connect to the default SSE server address
npx mcp-rest

# Connect to a custom SSE server address and port
npx mcp-rest --type sse --url http://localhost:9000/sse --port 4000

📚 Documentation

API Endpoints

Example API Usage

# Get the connection status
curl http://localhost:3000/status

# List all available tools
curl http://localhost:3000/tools

# Invoke a tool
curl -X POST http://localhost:3000/tools/exampleTool \
  -H "Content-Type: application/json" \
  -d '{"arguments": {"param1": "value1"}}'

🔧 Technical Details

If you encounter connection issues:

1. Use the --debug flag to view detailed logs.
2. Check the /status endpoint to verify the connection status.
3. Ensure that your MCP server/process is running and accessible.

📄 License

MIT