MCP Base - 通用模型上下文协议框架

此文件夹包含用于构建 AI 驱动应用程序的模型上下文协议 (MCP) 的通用基础实现。它提供了一种标准化的方法来创建 MCP 服务器和客户端，可用于将 LLM 集成到您的应用程序中。

📋 功能

• 标准化 MCP 服务器: 具有 HTTP 和 stdio 传输支持的基础服务器实现
• 通用 MCP 客户端: 用于连接到任何 MCP 服务器的客户端
• Ollama 集成: 随时可用的服务，用于使用 Ollama 生成嵌入和文本
• Supabase 集成: 内置对 Supabase 向量数据库的支持
• 模块化设计: 结构清晰，用于组织资源、工具和提示
• 示例模板: 示例实现，可帮助您快速入门

🛠️ 目录结构

_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            # 此文档

🚀 快速开始

前提条件

• 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'

服务器初始化

1. 导入所需的模块
2. 注册您的资源、工具和提示
3. 启动服务器

// 导入基础服务器和实用程序
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",
});

// 示例：调用一个工具
async function callSampleTool() {
  const result = await client.callTool("sample-tool", {
    query: "example query",
    maxResults: 5,
  });
  console.log(result);
}

// 示例：读取一个资源
async function readResource() {
  const items = await client.readResource("items://all");
  console.log(items);
}

// 示例：获取一个提示
async function getPrompt() {
  const prompt = await client.getPrompt("simple-prompt", {
    task: "Explain quantum computing",
  });
  console.log(prompt);
}

// 完成后不要忘记断开连接
await client.disconnect();

📚 扩展框架

创建新工具

1. 在 tools/ 目录中创建一个新文件
2. 使用 Zod 定义您的工具函数和模式
3. 实现您的工具逻辑
4. 在您的服务器中注册该工具

创建新资源

1. 在 resources/ 目录中创建一个新文件
2. 定义您的资源端点和模式
3. 实现您的资源逻辑
4. 在您的服务器中注册该资源

创建新提示

1. 在 prompts/ 目录中创建一个新文件
2. 定义您的提示模式和参数
3. 实现您的提示模板
4. 在您的服务器中注册该提示

📄 许可证

MIT