使用说明

项目简介

MINDY 项目是一个设计和开发资源库,集成了 Model Context Protocol (MCP) 服务器,旨在为 AI 模型提供结构化的资源和上下文数据访问能力。该 MCP 服务器基于 PostgreSQL 构建,可以连接到您的 Supabase 数据库,让 AI 模型能够安全、可扩展地访问和操作数据库中的上下文信息。

主要功能点

  • 资源管理: 通过 MCP 协议托管和管理存储在 PostgreSQL 数据库中的设计和开发资源。
  • 数据访问: 允许 LLM 客户端通过标准化的 MCP 接口访问 Supabase 数据库中的资源数据。
  • 工具集成: 支持通过 MCP 注册和执行工具(仓库中未明确提及,但 MCP 服务器具备此能力)。
  • Prompt 模板: 支持定义和渲染 Prompt 模板(仓库中未明确提及,但 MCP 服务器具备此能力)。
  • 会话管理: MCP 服务器负责会话管理,为客户端提供持久化的上下文服务。
  • 能力声明: MCP 服务器声明自身能力,方便客户端了解其支持的功能。
  • 多种传输协议支持: 基于 '@modelcontextprotocol/server-postgres',推测支持 Stdio, SSE, WebSocket 等协议 (需自行验证)。

安装步骤

  1. 克隆仓库

    git clone https://github.com/pedrojaques99/mindy-3.git
    cd mindy-3
  2. 安装依赖

    npm install
  3. 配置环境变量 在项目根目录下创建 '.env' 文件,并填入您的 Supabase 和 PostgreSQL 数据库连接信息:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
    SUPABASE_SERVICE_ROLE_KEY=your_supabase_service_role_key
    DATABASE_URL=postgresql://username:password@hostname:port/database

    确保 'DATABASE_URL' 指向您的 PostgreSQL 数据库,MCP 服务器将使用此连接字符串。

  4. 安装 MCP 服务器包

    npm install @modelcontextprotocol/server-postgres

服务器配置

MCP 服务器通过 'npm run mcp' 命令启动,并使用 '.env' 文件中 'DATABASE_URL' 配置的 PostgreSQL 数据库。

MCP 服务器配置信息 (JSON):

{
  "server name": "MINDY MCP Server",
  "command": "npm run mcp",
  "args": [],
  "description": "启动 MINDY MCP 服务器,连接到 PostgreSQL 数据库。",
  "notes": "请确保 .env 文件配置正确,并且 PostgreSQL 数据库服务已启动。"
}

配置信息说明:

  • 'server name': MCP 服务器的名称,可自定义。
  • 'command': 启动 MCP 服务器的命令,这里使用 'npm run mcp',对应 'package.json' 中定义的 'mcp' 脚本。
  • 'args': 启动命令的参数,本例中无需额外参数。
  • 'description': 对该配置的简要描述。
  • 'notes': 使用注意事项,提醒用户检查 '.env' 文件和数据库状态。

基本使用方法

  1. 启动 MCP 服务器 运行 'npm run mcp' 命令启动 MCP 服务器。

  2. 使用 MCP 客户端连接 使用任何 MCP 客户端,配置连接到 'npm run mcp' 启动的 MCP 服务器。客户端可以通过 JSON-RPC 协议与服务器交互,进行资源读取、工具调用和 Prompt 获取等操作。

  3. 参考 MCP 文档 更多关于 MCP 协议和客户端使用的信息,请参考 Model Context Protocol 文档

信息

分类

数据库与文件