Albacore

🚀 MCP 基礎 - 通用模型上下文協議框架

本項目提供了一個通用的實現基礎，用於構建由 AI 驅動的應用程序的 Model Context Protocol (MCP)。它為創建 MCP 服務器和客戶端提供了標準化方法，助力您將大語言模型（LLM）集成到應用程序中。

✨ 主要特性

• 標準化 MCP 服務器：支持 HTTP 和 stdio 運輸方式的基礎服務器實現。
• 通用 MCP 客戶端：可連接任何 MCP 服務器的客戶端。
• Ollama 集成：提供現成可用的服務，用於生成嵌入和文本（通過 Ollama）。
• Supabase 集成：內置對 Supabase 向量數據庫的支持。
• 模塊化設計：資源、工具和提示的組織結構清晰。
• 示例模板：提供示例實現，幫助您快速上手。

📦 安裝指南

先決條件

• 安裝 Node.js 和 npm/pnpm。
• 安裝 Ollama，用於本地嵌入和文本生成。
• 擁有 Supabase 賬戶，用於向量存儲。

環境配置

創建一個 .env 文件，並添加以下變量：

PORT=3000
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_SERVICE_KEY=your-service-key
OLLAMA_URL=http://localhost:11434
OLLAMA_EMBED_MODEL=nomic-embed-text
OLLAMA_LLM_MODEL=llama3
SERVER_MODE=http  # 'http' 或 'stdio'

💻 使用示例

基礎用法

服務器初始化

// 導入基礎服務器和 utilities
import server from "./server";
import { registerSampleResources } from "./resources/sample-resource";
import { registerSampleTool } from "./tools/sample-tool";
import { registerSamplePrompts } from "./prompts/sample-prompt";

// 初始化數據庫（如有必要）
async function initializeDatabase() {
  // 您的數據庫初始化邏輯
}

// 註冊您的組件
registerSampleResources(server, supabase);
registerSampleTool(server, textGenerator, embeddings, supabase);
registerSamplePrompts(server, supabase);

// 啟動服務器
startServer();

客戶端使用

import MCPClient from "./client";

// 創建一個客戶端實例
const client = new MCPClient({
  serverUrl: "http://localhost:3000",
});

// 調用工具示例
await client.invokeTool("sample-tool", { input: "test" });

// 讀取資源示例
const resourceData = await client.getResource("sample-resource");

// 獲取提示示例
const prompt = await client.getPrompts();

📚 詳細文檔

目錄結構

_mcp-base/
├── server.ts            # 主 MCP 服務器實現
├── client.ts            # 通用 MCP 客戶端
├── utils/               # 工具服務
│   ├── ollama_embedding.ts    # 使用 Ollama 進行嵌入生成
│   └── ollama_text_generation.ts  # 使用 Ollama 進行文本生成
├── tools/               # 工具實現
│   └── sample-tool.ts   # 示例工具模板
├── resources/           # 資源實現
│   └── sample-resource.ts  # 示例資源模板
├── prompts/             # 提示實現
│   └── sample-prompt.ts # 示例提示模板
└── README.md            # 此文檔

擴展框架

要添加新的功能，您可以按照以下步驟操作：

1. 創建新工具：在 tools/ 文件夾中創建一個新的工具文件，並導出工具函數。
2. 註冊工具：在 server.ts 中導入並註冊您的新工具。
3. 使用工具：客戶端可以通過調用 invokeTool 方法使用您的新工具。

📄 許可證

此項目採用 MIT 許可證。