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 许可证。