使用说明

项目简介

Minima 是一个开源的本地 RAG (Retrieval-Augmented Generation) 应用，旨在帮助用户在本地环境中基于自己的文档进行问答。Minima MCP 服务器是 Minima 项目的一部分，它作为一个符合 Model Context Protocol (MCP) 协议的服务器，允许 LLM 客户端（例如 Anthropic Claude 桌面应用）安全地访问和利用 Minima 提供的本地 RAG 功能。

主要功能点

本地文档检索: 允许 LLM 客户端查询和检索用户本地文件中的信息。
工具集成: 提供 'query' 工具，允许客户端触发本地文档的搜索功能。
Prompt 模板: 支持 'query' Prompt，客户端可以使用它来构造对本地知识库的查询。
MCP 协议支持: 通过标准的 MCP 协议与 LLM 客户端通信，实现上下文信息的传递和功能调用。

安装步骤

确保本地机器已安装 Python (>=3.10) 和 'uv'。

克隆 Minima 仓库到本地：

git clone https://github.com/dmayboroda/minima.git

进入 'mcp-server' 目录：

cd minima/mcp-server

运行 Docker Compose 启动 MCP 服务器：

docker compose -f ../docker-compose-mcp.yml --env-file ../.env up --build

(确保 '.env' 文件已配置 'LOCAL_FILES_PATH' 和其他必要的环境变量，参考仓库 'README.md')

服务器配置 (for MCP Client, e.g., Claude)

以下 JSON 配置信息用于配置 MCP 客户端连接到 Minima MCP 服务器。例如，在 Anthropic Claude 桌面应用中，你需要将以下配置添加到 'claude_desktop_config.json' 文件中：

{
    "server_name": "minima",
    "command": "uv",
    "args": [
        "--directory",
        "/path_to_cloned_minima_project/mcp-server",
        "run",
        "minima"
    ]
}

'server_name': MCP 服务器的名称，可以自定义，例如 "minima"。
'command': 启动 MCP 服务器的命令，这里使用 'uv' (一个 Python 包安装和运行工具)。
'args': 传递给 'uv run' 命令的参数列表。
- '--directory': 指定 MCP 服务器代码所在的目录，需要替换为克隆的 'minima' 项目中 'mcp-server' 目录的 绝对路径。请务必修改为你的实际路径。
- 'run': 'uv' 命令的子命令，用于运行 Python 包。
- 'minima': 指定要运行的 Python 包的名称，对应 'mcp-server/src/minima/init.py' 中定义的 'main()' 函数。

注意: '/path_to_cloned_minima_project/mcp-server' 需要替换为你本地克隆仓库中 'mcp-server' 目录的绝对路径。

基本使用方法

启动 Minima MCP 服务器 (按照安装步骤)。
配置 MCP 客户端（例如 Anthropic Claude 桌面应用），将上述服务器配置信息添加到客户端的配置文件中 (例如 Claude 的 'claude_desktop_config.json')。
在 MCP 客户端中，选择配置的 "minima" 服务器。
在客户端中发起查询，Minima MCP 服务器将处理请求并在本地文档中搜索相关信息，然后将结果返回给客户端。

关键词