使用说明
项目简介
这是一个基于 Model Context Protocol (MCP) 的服务器模板,旨在帮助开发者为 Cursor IDE 快速构建自定义工具。通过此模板,您可以轻松创建能够扩展 LLM 功能的后端服务,例如从网页抓取信息、调用外部API或处理Figma设计数据。该服务器实现了 MCP 协议,可以与任何兼容 MCP 协议的客户端(如 Cursor IDE)进行通信。
主要功能点
- 网页内容抓取 (mcp_fetch): 允许 LLM 获取指定 URL 的网页内容。
- 心情检测 (mood): 一个简单的示例工具,用于演示工具调用,始终返回积极的心情反馈。
- 图像生成 (generate_image): 集成 DALL-E 3 模型,根据文本描述生成图像。
- Figma 设计数据获取 (figma_design): 支持从 Figma 设计稿中提取结构和图像数据。
- 支持多种部署方式: 提供 Docker 部署、传统 Python 安装和 Smithery 快速安装等多种部署选项。
- 支持 Stdio 和 SSE 传输协议: 兼容不同的客户端连接方式。
安装步骤
1. 选择部署方式: 您可以选择以下任一方式部署 MCP 服务器:
-
Heroku 快速部署 (推荐,最简便):
- 点击 README 中的 "Deploy to Heroku" 按钮,按照 Heroku 的引导完成部署。
- 部署完成后,您将获得一个 Heroku 应用 URL。
-
Docker 部署:
- 确保您的机器已安装 Docker 和 Docker Compose。
- 克隆仓库到本地:'git clone https://github.com/kirill-markin/weaviate-mcp-server.git'
- 进入仓库目录:'cd weaviate-mcp-server'
- 复制并配置 '.env' 文件:'cp .env.example .env' (如有需要,修改 '.env' 文件中的环境变量,例如 'OPENAI_API_KEY' 和 'FIGMA_ACCESS_TOKEN')
- 构建并启动 Docker 容器:'docker compose up --build -d'
- 服务器将在 'http://localhost:8000/sse' 启动。
-
传统 Python 安装:
- 确保您的机器已安装 Python 和 'uv' 包管理器 (可以使用 'pip install uv' 安装)。
- 克隆仓库到本地。
- 进入仓库目录。
- 安装项目依赖:'uv pip install -e ".[dev]"'
- 启动服务器 (默认使用 stdio 传输): 'uv run mcp-simple-tool'
- 或使用 SSE 传输并指定端口: 'uv run mcp-simple-tool --transport sse --port 8000'
-
Smithery 快速安装:
- 如果您使用 Claude Desktop,可以使用 Smithery 快速安装:
- 运行命令:'npx -y @smithery/cli install @kirill-markin/example-mcp-server --client claude'
2. 配置 MCP 服务器 (以 Cursor IDE 为例):
打开 Cursor IDE 的设置 (Settings) -> Features -> MCP Servers,点击 "Add new MCP server"。
根据您选择的部署方式,填写以下配置信息:
如果您使用 Heroku 部署或 Docker 部署 (SSE 传输):
- Server Name: 自定义服务器名称 (例如: 'my-mcp-server')
- Type: 选择 'sse'
- URL: 填写您的服务器 URL,例如 Heroku 应用 URL 加上 '/sse' 路径 (例如: 'https://<your-app-name>.herokuapp.com/sse') 或 Docker 部署的 URL ('http://localhost:8000/sse')
如果您使用传统 Python 安装 (stdio 传输):
-
Server Name: 自定义服务器名称 (例如: 'my-local-mcp-server')
-
Type: 选择 'stdio'
-
Command: 填写服务器启动命令的绝对路径。
- 如果您使用 'uv run mcp-simple-tool' 启动服务器,'command' 通常设置为 'uv'
- Args: 启动参数,通常设置为 'run mcp-simple-tool'
配置示例 (stdio 传输):
{ "serverName": "my-local-mcp-server", "type": "stdio", "command": "uv", "args": ["run", "mcp-simple-tool"] }配置示例 (SSE 传输, 假设 Heroku URL 为 'https://my-app.herokuapp.com'):
{ "serverName": "my-heroku-mcp-server", "type": "sse", "url": "https://my-app.herokuapp.com/sse" }
基本使用方法
配置完成后,您可以在 Cursor IDE 中通过自然语言指令调用 MCP 服务器提供的工具。例如:
- 使用网页内容抓取工具: 在 Cursor IDE 中提问类似 "请帮我获取 https://www.example.com 的网页内容" 的问题,服务器将调用 'mcp_fetch' 工具抓取网页内容并返回。
- 使用图像生成工具: 提问类似 "请生成一张猫咪在宇宙中飞行的图片" 的问题,服务器将调用 'generate_image' 工具生成图像 URL 并返回。
- 使用 Figma 设计数据工具: 提问类似 "请分析这个 Figma 设计稿 [Figma URL]" 的问题,服务器将调用 'figma_design' 工具获取 Figma 数据。
- 测试心情检测工具: 提问类似 "服务器你今天心情怎么样?" 的问题,服务器将调用 'mood' 工具并返回预设的积极回复。
请注意,部分工具 (例如 'generate_image' 和 'figma_design') 可能需要您配置相应的 API 密钥 (例如 'OPENAI_API_KEY' 和 'FIGMA_ACCESS_TOKEN') 作为环境变量。
信息
分类
开发者工具