使用说明

项目简介

Gardenbook Plant MCP Server 是 Gardenbook 项目的后端组件,专注于植物信息的管理和数据访问。它实现了 Model Context Protocol (MCP) 服务器,旨在为语言模型 (LLM) 应用提供结构化的植物数据服务。通过标准化的 MCP 协议,LLM 客户端可以安全、便捷地访问和操作植物资源,构建智能化的园艺助手应用。

主要功能点

  • 植物资源管理: 集中托管和管理园艺应用中的植物数据。
  • 数据CRUD接口: 提供完善的植物信息增 (创建)、删 (删除)、改 (更新)、查 (读取) 功能,满足 LLM 应用对植物数据的多样化需求。
  • MCP协议标准: 基于 MCP 协议构建,采用 JSON-RPC 通信,保证与 MCP 客户端的互操作性和标准化交互。
  • 工具注册与执行: 注册 'get_plants', 'get_plant_by_id', 'create_plant', 'update_plant', 'delete_plant' 等工具,允许 LLM 客户端调用这些工具来操作植物数据。
  • Stdio传输协议: 支持 Stdio 传输协议,简化部署和集成。

安装步骤

  1. 安装 Docker 和 Docker Compose: 确保您的系统已安装 Docker 和 Docker Compose。
  2. 克隆仓库: 使用 Git 克隆 'gardenbook-web' 仓库到本地:
    git clone https://github.com/Tearemuptara/gardenbook-web.git
    cd gardenbook-web
  3. 启动服务: 在仓库根目录下,运行 Docker Compose 启动 Gardenbook 项目的所有服务,包括植物 MCP 服务器:
    docker-compose up
    这将会构建并启动包括前端、数据库API和聊天API在内的所有 Gardenbook 组件,植物 MCP 服务器将作为 'gardenbook_chat_api' 的一部分在 Docker 容器中运行。

服务器配置

MCP 服务器配置信息 (JSON 格式) 用于 MCP 客户端连接到 Gardenbook Plant MCP Server。客户端需要配置服务器的启动命令 (command) 及其参数 (args)。

{
  "server name": "garden",  // 服务器名称,客户端用此名称引用
  "command": "python",      // 启动服务器的命令,这里使用 Python 解释器
  "args": ["/app/gardenbook_chat_api/gardenbook_chat/plants-mcp/garden_mcp.py"] // 传递给命令的参数,指定 MCP 服务器脚本在容器内的路径
}

请注意: '/app/gardenbook_chat_api/gardenbook_chat/plants-mcp/garden_mcp.py' 是 MCP 服务器脚本在 Docker 容器内部的路径。MCP 客户端配置时,应根据实际部署环境调整路径。

基本使用方法

  1. 启动 Gardenbook 项目: 按照安装步骤启动 Gardenbook 项目,植物 MCP 服务器将随之启动。
  2. MCP 客户端连接: 配置 MCP 客户端(例如 LangChain 或其他 MCP 客户端库)使用上述服务器配置信息连接到 Gardenbook Plant MCP Server。
  3. 工具调用: 客户端连接成功后,可以发现并调用服务器提供的工具,例如:
    • 调用 'get_plants' 工具获取所有植物列表。
    • 调用 'get_plant_by_id' 工具并传入植物 ID,获取特定植物的详细信息。
    • 调用 'create_plant' 工具并传入植物名称、科学名称等参数,创建新的植物记录。
    • 调用 'update_plant' 和 'delete_plant' 工具更新和删除植物信息。
  4. 数据交互: 通过工具调用,客户端可以与植物 MCP 服务器进行数据交互,实现植物数据的查询和管理功能,从而支持智能园艺应用场景。

信息

分类

数据库与文件