MCP Rest

🚀 MCP REST API 文檔

這是一個圍繞模型上下文協議（Model Context Protocol，MCP）客戶端構建的REST API封裝器，它能讓你在不必保持恆連接的情況下與MCP進行交互。不過需要注意的是，本項目僅供測試使用，請勿用於實際場景。

🚀 快速開始

本項目提供了便捷的安裝和使用方式，幫助你快速開啟與MCP的交互。

📦 安裝指南

你可以選擇全局安裝或者使用 npx 運行：

# 全局安裝
npm install -g mcp-rest

# 或使用npx運行
npx mcp-rest

💻 使用示例

基礎用法

使用以下命令運行，並可根據需求添加選項：

npx mcp-rest [選項]

選項說明

高級用法

SSE 模式

# 連接到默認的SSE服務器地址
npx mcp-rest

# 連接到自定義的SSE服務器地址和端口
npx mcp-rest --type sse --url http://localhost:9000/sse --port 4000

📚 詳細文檔

API 終端點

示例 API 使用方法

# 獲取連接狀態
curl http://localhost:3000/status

# 列出所有可用工具
curl http://localhost:3000/tools

# 調用一個工具
curl -X POST http://localhost:3000/tools/exampleTool \
  -H "Content-Type: application/json" \
  -d '{"arguments": {"param1": "value1"}}'

🔧 技術細節

如果遇到連接問題，你可以按照以下步驟進行故障排除：

1. 使用 --debug 標誌查看詳細日誌
2. 檢查 /status 終端點以驗證連接狀態
3. 確保你的 MCP 服務器/進程正在運行且可訪問

📄 許可證

本項目採用 MIT 許可證。