From 1ddc87349e599189f712eb40cb4941efcc8466ac Mon Sep 17 00:00:00 2001 From: zy Date: Sun, 17 Aug 2025 16:33:08 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=20MCP=20=E6=9C=8D?= =?UTF-8?q?=E5=8A=A1=E6=8E=A5=E5=85=A5=E6=96=87=E6=A1=A3=EF=BC=8C=E6=96=B0?= =?UTF-8?q?=E5=A2=9E=20VSCode=20=E9=85=8D=E7=BD=AE=E6=94=AF=E6=8C=81=20(#1?= =?UTF-8?q?4)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 文档改进： - 📝 重构 MCP_README.md，使文档更加简洁实用 - ✨ 新增 VSCode 的 MCP 配置示例和说明 - 🔧 提供多种配置方式：全局设置和工作区设置 - 📚 更新主 README.md，添加 VSCode 到支持的客户端列表 - 🎯 优化文档结构，提升用户体验 支持的 MCP 客户端： ✅ Claude Code CLI ✅ Claude Desktop ✅ Cursor ✅ VSCode (新增) ✅ MCP Inspector 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude --- MCP_README.md | 166 +++++++++++++++++++++++++++++++++++++++++++++++--- README.md | 36 +++++++---- 2 files changed, 181 insertions(+), 21 deletions(-) diff --git a/MCP_README.md b/MCP_README.md index 12a967d..d95f53a 100644 --- a/MCP_README.md +++ b/MCP_README.md @@ -1,17 +1,163 @@ -# 小红书 MCP 服务使用说明 +# MCP 服务接入指南 -本服务已集成 Model Context Protocol (MCP) 支持，通过 HTTP JSON-RPC 协议提供服务。 +本文档介绍如何在各种 AI 客户端中接入小红书 MCP 服务。 -## 服务端点 +## 🚀 快速开始 -- **HTTP API**: `http://localhost:18060/api/v1/*` -- **MCP 协议**: `http://localhost:18060/mcp` - -## 可用的 MCP 工具 - -使用 Claude Code CLI 添加 HTTP 端点： +### 1. 启动 MCP 服务 ```bash -# 添加HTTP类型的MCP服务器 +# 启动服务（默认无头模式） +go run . + +# 或者有界面模式 +go run . -headless=false +``` + +服务将运行在：`http://localhost:18060/mcp` + +### 2. 验证服务状态 + +```bash +# 测试 MCP 连接 +curl -X POST http://localhost:18060/mcp \ + -H "Content-Type: application/json" \ + -d '{"jsonrpc":"2.0","method":"initialize","params":{},"id":1}' +``` + +## 📱 客户端接入 + +### Claude Desktop + +在 `~/.config/claude-desktop/claude_desktop_config.json` 中添加： + +```json +{ + "mcpServers": { + "xiaohongshu": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/client-stdio", "http://localhost:18060/mcp"], + "env": {} + } + } +} +``` + +### Claude Code CLI + +```bash +# 添加 HTTP MCP 服务器 claude mcp add --transport http xiaohongshu-mcp http://localhost:18060/mcp ``` + +### Cursor + +在 Cursor 设置中添加 MCP 配置： + +```json +{ + "mcp.servers": { + "xiaohongshu": { + "command": "node", + "args": ["-e", "/* HTTP proxy script */"], + "description": "小红书内容发布服务" + } + } +} +``` + +### VSCode + +安装 MCP 扩展并配置： + +1. 安装 [MCP for VSCode](https://marketplace.visualstudio.com/search?term=mcp&target=VSCode) 扩展 +2. 在 VSCode 设置中添加配置（`Ctrl/Cmd + ,` → 搜索 "mcp"）： + +```json +{ + "mcp.servers": { + "xiaohongshu-mcp": { + "command": "curl", + "args": [ + "-X", "POST", + "http://localhost:18060/mcp", + "-H", "Content-Type: application/json", + "-d", "@-" + ], + "description": "小红书内容发布和管理服务" + } + } +} +``` + +或者在工作区的 `.vscode/settings.json` 中添加： + +```json +{ + "mcp.servers": { + "xiaohongshu-mcp": { + "transport": "http", + "endpoint": "http://localhost:18060/mcp", + "description": "小红书 MCP 服务" + } + } +} + +### 通用 MCP Inspector（调试用） + +```bash +# 启动 MCP Inspector +npx @modelcontextprotocol/inspector + +# 在浏览器中连接到：http://localhost:18060/mcp +``` + +## 🛠️ 可用工具 + +连接成功后，可使用以下 MCP 工具： + +- `check_login_status` - 检查小红书登录状态 +- `publish_content` - 发布图文内容到小红书 +- `list_feeds` - 获取小红书首页推荐列表 + +## 📝 使用示例 + +### 检查登录状态 + +```json +{ + "name": "check_login_status", + "arguments": {} +} +``` + +### 发布内容 + +```json +{ + "name": "publish_content", + "arguments": { + "title": "标题", + "content": "内容描述", + "images": ["图片URL或本地路径"] + } +} +``` + +## ⚠️ 注意事项 + +1. **首次使用需要登录**：运行 `go run cmd/login/main.go` 完成登录 +2. **网络要求**：确保客户端能访问 `localhost:18060` +3. **权限验证**：某些操作需要有效的登录状态 + +## 🔧 故障排除 + +### 连接失败 +- 检查服务是否运行：`curl http://localhost:18060/health` +- 确认端口未被占用 +- 检查防火墙设置 + +### 工具调用失败 +- 确认已完成小红书登录 +- 检查图片URL或路径是否有效 +- 查看服务日志获取详细错误信息 diff --git a/README.md b/README.md index 2ca367f..f3dfda1 100644 --- a/README.md +++ b/README.md @@ -63,37 +63,51 @@ npx @modelcontextprotocol/inspector ![发布图文](./assets/inspect_mcp_publish.gif) -## 2. MCP 集成 +## 2. MCP 客户端接入 -各种 MCP 集成工具，都可以使用这个 MCP 服务。 +本服务支持标准的 Model Context Protocol (MCP)，可以接入各种支持 MCP 的 AI 客户端。 -### 2.1. Claude Cli +📖 **详细接入指南**：[MCP_README.md](./MCP_README.md) + +### 2.1. 快速开始 ```bash -# localhost 是本机，如果是远程的话，更换成对应的 IP 地址。 +# 启动 MCP 服务 +go run . + +# 使用 Claude Code CLI 接入 claude mcp add --transport http xiaohongshu-mcp http://localhost:18060/mcp ``` -这里使用 Claude Code With K2 做演示，接入方式参考：[在 software agents 中使用 kimi k2 模型](https://platform.moonshot.cn/docs/guide/agent-support)。 +### 2.2. 支持的客户端 -**示例：** +- ✅ **Claude Code CLI** - 官方命令行工具 +- ✅ **Claude Desktop** - 桌面应用 +- ✅ **Cursor** - AI 代码编辑器 +- ✅ **VSCode** - 通过 MCP 扩展支持 +- ✅ **MCP Inspector** - 调试工具 +- ✅ 其他支持 HTTP MCP 的客户端 -以 [Product Hunt 日报](https://product-daily.haha.ai/) 上面的一篇图片为例，使用 Claude Code 进行发布。 +### 2.3. 可用 MCP 工具 -打开 Claude Code 后，输入： +- `check_login_status` - 检查登录状态 +- `publish_content` - 发布图文内容 +- `list_feeds` - 获取推荐列表 + +### 2.4. 使用示例 + +使用 Claude Code 发布内容到小红书： ``` 帮我写一篇帖子发布到小红书上， 配图为：https://cn.bing.com/th?id=OHR.MaoriRock_EN-US6499689741_UHD.jpg&w=3840 -图片是：“纽西兰陶波湖的Ngātoroirangi矿湾毛利岩雕（© Joppi/Getty Images）” +图片是："纽西兰陶波湖的Ngātoroirangi矿湾毛利岩雕（© Joppi/Getty Images）" 使用 xiaohongshu-mcp 进行发布。 ``` ![claude-cli 进行发布](./assets/claude_push.gif) -高清版本可以参考：[claude-cli 进行发布](./assets/claude_push.mp4) - **发布结果：** xiaohongshu-mcp 发布结果