使用说明

项目简介

mcp-framework是一个基于Model Context Protocol (MCP) 的开发框架，旨在帮助开发者快速构建能够与大语言模型（LLM）交互的后端服务。该框架预置了多种实用工具，如文件内容解析（PDF, Word, Excel）和网页内容抓取，能够显著扩展LLM应用的功能，例如与Cursor IDE集成，实现更强大的文档处理和信息检索能力。

主要功能点

综合文件处理: 支持自动识别和处理PDF、Word、Excel等多种文件格式，提取文本、图片、表格等内容。
网页内容获取: 能够抓取指定URL的网页内容，为LLM提供实时的网络信息。
灵活的工具扩展: 采用模块化设计，方便开发者自定义和添加新的工具，满足不同的应用场景需求。
多种部署方式: 支持Docker和传统Python环境部署，方便用户快速搭建和使用。
兼容MCP协议: 遵循Model Context Protocol标准，可以与任何兼容MCP协议的客户端进行通信。

安装步骤

Docker 部署 (推荐):

克隆仓库

git clone https://github.com/aigo666/mcp-framework.git
cd mcp-framework

创建并配置 .env 文件 复制 '.env.example' 文件并重命名为 '.env'，根据需要修改其中的环境变量，例如端口号 'MCP_SERVER_PORT'。

cp .env.example .env
# 可选：编辑 .env 文件修改配置

使用 Docker Compose 启动服务

docker compose up --build -d

等待Docker镜像下载和容器启动完成。

查看服务日志 (可选)

docker compose logs -f

传统 Python 部署:

安装系统依赖 根据您的操作系统安装必要的系统依赖，例如 'poppler-utils' (PDF处理), 'tesseract-ocr' (OCR)。以 Ubuntu/Debian 为例:
```
sudo apt-get update
sudo apt-get install -y poppler-utils tesseract-ocr tesseract-ocr-chi-sim
```
macOS 用户可以使用 'brew install poppler tesseract tesseract-lang'。Windows 用户需要手动下载安装 Tesseract 并配置环境变量。

创建并激活虚拟环境

python -m venv venv
source venv/bin/activate  # Linux/macOS
# 或
.\venv\Scripts\activate  # Windows

安装 Python 依赖

pip install -r requirements.txt

启动 MCP 服务器
```
python -m mcp_tool
```

服务器配置

对于 MCP 客户端 (例如 Cursor IDE)，您需要配置 MCP 服务器的连接信息。以下是使用 SSE 传输协议时的配置示例 (JSON 格式):

{
  "serverName": "mcp-framework",
  "transport": "sse",
  "command": "docker",
  "args": [
    "compose",
    "exec",
    "server",  // Docker Compose 服务名，如果直接python部署可以忽略docker相关
    "python",
    "-m",
    "mcp_tool",
    "--transport",
    "sse"
  ],
  "url": "http://localhost:8000/sse"  // SSE 端点 URL，根据实际部署情况修改
}

参数说明:

'"serverName"': MCP 服务器的名称，可以自定义。
'"transport"': 传输协议，这里设置为 '"sse"' (Server-Sent Events)。
'"command"': 启动 MCP 服务器的命令。
- Docker 部署: 使用 'docker compose exec server python' 进入 Docker 容器的 'server' 服务，并执行 'python -m mcp_tool --transport sse' 命令。
- Python 部署: 如果直接使用 Python 部署，可以将 '"command"' 简化为 '"python"'， '"args"' 为 '["-m", "mcp_tool", "--transport", "sse"]'。
'"args"': 传递给启动命令的参数。
- '--transport sse': 指定使用 SSE 传输协议。
'"url"': SSE 端点的 URL。默认 Docker 部署和 Python 部署的本地访问地址均为 'http://localhost:8000/sse'。

基本使用方法

启动 MCP 服务器: 根据上述安装步骤启动 mcp-framework 服务器。
配置 MCP 客户端: 在兼容 MCP 协议的客户端 (例如 Cursor IDE) 中，添加 MCP 服务器，并填入上述配置信息。
使用工具: 在客户端中，您应该能够调用 mcp-framework 提供的工具，例如 'file' (文件处理), 'url' (网页内容获取) 等。具体工具的使用方法请参考仓库 README.md 文件中 "主要功能" 部分的说明。例如，在 Cursor IDE 中，您可以使用 '@file /path/to/your/document.pdf' 来解析 PDF 文件。

请根据您的实际部署环境 (Docker 或 Python) 和客户端软件，正确配置 MCP 服务器连接信息。

关键词

使用说明

项目简介

主要功能点

安装步骤

服务器配置

信息