项目简介

本项目是一个 MCP 服务器模板,旨在帮助开发者快速构建自定义工具并集成到 Cursor IDE 等 MCP 客户端。它提供了一个网页抓取工具和一个简单的服务器状态查询工具作为示例,展示了如何使用 Model Context Protocol (MCP) 构建应用后端服务。

主要功能点

  • 网页内容抓取: 提供 'mcp_fetch' 工具,允许客户端通过 URL 获取网页的文本内容。
  • 服务器状态查询: 提供 'mood' 工具,用于查询服务器的心情,服务器总是会返回积极友好的回复。
  • 支持多种部署方式: 可以通过 Heroku 一键部署,也可以使用 Docker 或传统的 Python 环境运行。
  • 兼容 Stdio 和 SSE 传输协议: 支持与 MCP 客户端通过标准输入输出流 (stdio) 或服务器发送事件 (SSE) 进行通信。
  • 易于配置和扩展: 作为一个模板,用户可以根据需要修改和添加更多自定义工具。

安装步骤

您可以选择以下任一方式安装和运行 MCP 服务器:

1. Heroku 部署 (推荐快速体验)

  • 点击 README.md 中的 "Deploy to Heroku" 按钮,按照 Heroku 的指引完成部署。
  • 部署完成后,您将获得一个 Heroku 应用 URL。

2. Docker 部署

  • 确保您已安装 Docker 和 Docker Compose。
  • 克隆仓库到本地:
    git clone https://github.com/kirill-markin/weaviate-mcp-server.git
    cd weaviate-mcp-server
  • 启动 Docker 容器:
    docker compose up --build -d
  • 服务器将在 'http://localhost:8000/sse' 启动。

3. 传统 Python 环境运行

  • 确保您已安装 Python 3.8 或更高版本。
  • 安装 uv 包管理器 (推荐): 'brew install uv' 或 'pip install uv'
  • 安装项目依赖:'uv pip install -e ".[dev]"'
  • 启动服务器:
    • 使用 stdio 传输 (默认): 'uv run mcp-simple-tool'
    • 使用 SSE 传输 (指定端口 8000): 'uv run mcp-simple-tool --transport sse --port 8000'

服务器配置 (用于 MCP 客户端)

以下是在 MCP 客户端 (如 Cursor IDE) 中配置本 MCP 服务器的示例配置信息。您需要根据您的部署方式选择合适的配置。

针对本地 Stdio 运行 (使用 'cursor-run-mcp-server.sh' 脚本)

{
  "serverName": "my-website-fetcher",  // 自定义服务器名称
  "type": "stdio",                     // 连接类型为 stdio
  "command": "/path/to/weaviate-mcp-server/cursor-run-mcp-server.sh" // 替换为 'cursor-run-mcp-server.sh' 脚本的绝对路径
}

针对本地 SSE 运行 (Docker 或 Python 环境,SSE 传输)

{
  "serverName": "my-website-fetcher",  // 自定义服务器名称
  "type": "sse",                       // 连接类型为 SSE
  "url": "http://localhost:8000/sse"   // 本地 SSE 服务器地址,Docker 或 Python 默认地址
}

针对 Heroku 部署

{
  "serverName": "my-website-fetcher",  // 自定义服务器名称
  "type": "sse",                       // 连接类型为 SSE
  "url": "https://<your-heroku-app-name>.herokuapp.com/sse" // 替换为您的 Heroku 应用 URL,并确保路径为 /sse
}

配置步骤 (以 Cursor IDE 为例)

  1. 打开 Cursor 设置 (Settings) -> Features。
  2. 滚动到 "MCP Servers" 部分。
  3. 点击 "Add new MCP server"。
  4. 填写表单:
    • Name: 自定义服务器名称 (例如: 'my-website-fetcher')
    • Type: 根据您的运行方式选择 "stdio" 或 "sse"。
    • CommandURL: 根据上面的配置信息填写相应的命令或 URL。

基本使用方法

  1. 确保 MCP 服务器已成功启动并配置到 MCP 客户端。
  2. 在 MCP 客户端中,您可以指示客户端调用服务器提供的工具。例如,在 Cursor IDE 中,您可以提问:
    • "请使用 'mcp_fetch' 工具抓取 [网页 URL] 的内容"
    • "问问服务器现在心情怎么样" (触发 'mood' 工具)

服务器将处理客户端的请求,并返回相应的结果。

信息

分类

网页与API