feat: add instructions for cline mcp setup (#149)
This commit is contained in:
Melo Y Guan
80
README_EN.md
80
README_EN.md
@@ -1,6 +1,9 @@
|
||||
# xiaohongshu-mcp
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
|
||||
[](#contributors-)
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
MCP for RedNote (Xiaohongshu) platform.
|
||||
@@ -40,6 +43,7 @@ Supports publishing image and text content to RedNote, including title, content
|
||||
Supports two image input methods:
|
||||
|
||||
1. **HTTP/HTTPS Image Links**
|
||||
|
||||
```
|
||||
["https://example.com/image1.jpg", "https://example.com/image2.png"]
|
||||
```
|
||||
@@ -50,6 +54,7 @@ Supports two image input methods:
|
||||
```
|
||||
|
||||
**Why Local Paths are Recommended:**
|
||||
|
||||
- ✅ Better stability, not dependent on network
|
||||
- ✅ Faster upload speed
|
||||
- ✅ Avoid image link expiration issues
|
||||
@@ -147,6 +152,7 @@ Get RedNote user's personal profile information, including basic user informatio
|
||||
- These parameters can be obtained from Feed list or search results
|
||||
|
||||
**Returned Information Includes:**
|
||||
|
||||
- User basic info: nickname, bio, avatar, verification status
|
||||
- Statistics: following count, follower count, likes count, note count
|
||||
- Note list: all public notes published by the user
|
||||
@@ -190,18 +196,21 @@ Results after about a week
|
||||
Download pre-compiled binaries for your platform directly from [GitHub Releases](https://github.com/xpzouying/xiaohongshu-mcp/releases):
|
||||
|
||||
**Main Program (MCP Service):**
|
||||
|
||||
- **macOS Apple Silicon**: `xiaohongshu-mcp-darwin-arm64`
|
||||
- **macOS Intel**: `xiaohongshu-mcp-darwin-amd64`
|
||||
- **Windows x64**: `xiaohongshu-mcp-windows-amd64.exe`
|
||||
- **Linux x64**: `xiaohongshu-mcp-linux-amd64`
|
||||
|
||||
**Login Tool:**
|
||||
|
||||
- **macOS Apple Silicon**: `xiaohongshu-login-darwin-arm64`
|
||||
- **macOS Intel**: `xiaohongshu-login-darwin-amd64`
|
||||
- **Windows x64**: `xiaohongshu-login-windows-amd64.exe`
|
||||
- **Linux x64**: `xiaohongshu-login-linux-amd64`
|
||||
|
||||
Usage Steps:
|
||||
|
||||
```bash
|
||||
# 1. First run the login tool
|
||||
chmod +x xiaohongshu-login-darwin-arm64
|
||||
@@ -245,12 +254,14 @@ For Windows issues, check here first: [Windows Installation Guide](./docs/window
|
||||
First time requires manual login to save RedNote login status.
|
||||
|
||||
**Using Binary Files:**
|
||||
|
||||
```bash
|
||||
# Run the login tool for your platform
|
||||
./xiaohongshu-login-darwin-arm64
|
||||
```
|
||||
|
||||
**Using Source Code:**
|
||||
|
||||
```bash
|
||||
go run cmd/login/main.go
|
||||
```
|
||||
@@ -260,6 +271,7 @@ go run cmd/login/main.go
|
||||
Start xiaohongshu-mcp service.
|
||||
|
||||
**Using Binary Files:**
|
||||
|
||||
```bash
|
||||
# Default: Headless mode, no browser interface
|
||||
./xiaohongshu-mcp-darwin-arm64
|
||||
@@ -269,6 +281,7 @@ Start xiaohongshu-mcp service.
|
||||
```
|
||||
|
||||
**Using Source Code:**
|
||||
|
||||
```bash
|
||||
# Default: Headless mode, no browser interface
|
||||
go run .
|
||||
@@ -483,6 +496,59 @@ Usage steps:
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Cline</b></summary>
|
||||
|
||||
Cline is a powerful AI programming assistant that supports MCP protocol integration.
|
||||
|
||||
#### Configuration Method
|
||||
|
||||
Add the following configuration to Cline's MCP settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"xiaohongshu-mcp": {
|
||||
"url": "http://localhost:18060/mcp",
|
||||
"type": "streamableHttp",
|
||||
"autoApprove": [],
|
||||
"disabled": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Usage Steps
|
||||
|
||||
1. Ensure RedNote MCP service is running (`http://localhost:18060/mcp`)
|
||||
2. Open MCP settings in Cline
|
||||
3. Add the above configuration to the MCP server list
|
||||
4. Save configuration and restart Cline
|
||||
5. You can directly use RedNote-related features in conversations
|
||||
|
||||
#### Configuration Explanation
|
||||
|
||||
- `url`: MCP service address
|
||||
- `type`: Use `streamableHttp` type for better performance
|
||||
- `autoApprove`: Configurable auto-approve tool list (empty means manual approval)
|
||||
- `disabled`: Set to `false` to enable this MCP service
|
||||
|
||||
#### Usage Examples
|
||||
|
||||
After configuration, you can use natural language to operate RedNote directly in Cline:
|
||||
|
||||
```
|
||||
Help me check RedNote login status
|
||||
```
|
||||
|
||||
```
|
||||
Help me publish a spring-themed image-text post to RedNote, using this image: /path/to/spring.jpg
|
||||
```
|
||||
|
||||
```
|
||||
Search for content about "food" on RedNote
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><b>Other HTTP MCP Supporting Clients</b></summary>
|
||||
|
||||
@@ -518,6 +584,7 @@ After successful connection, you can use the following MCP tools:
|
||||
Using Claude Code to publish content to RedNote:
|
||||
|
||||
**Example 1: Using HTTP Image Links**
|
||||
|
||||
```
|
||||
Help me write a post to publish on RedNote,
|
||||
with image: https://cn.bing.com/th?id=OHR.MaoriRock_EN-US6499689741_UHD.jpg&w=3840
|
||||
@@ -527,6 +594,7 @@ Use xiaohongshu-mcp for publishing.
|
||||
```
|
||||
|
||||
**Example 2: Using Local Image Paths (Recommended)**
|
||||
|
||||
```
|
||||
Help me write a post about spring to publish on RedNote,
|
||||
using these local images:
|
||||
@@ -586,11 +654,10 @@ Switched to Feishu group, scan QR code to join directly
|
||||
|
||||
<!-- Two-column layout: Feishu Group 2 | WeChat Group 3 -->
|
||||
|
||||
| 【Feishu Group 2】: Scan to join | 【WeChat Group 3】: Scan to join |
|
||||
| 【Feishu Group 2】: Scan to join | 【WeChat Group 3】: Scan to join |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <img src="https://github.com/user-attachments/assets/ca1f5d6e-b1bf-4c15-9975-ff75f339ec9b" alt="qrcode_2qun" width="300"> | <img src="https://github.com/user-attachments/assets/7665056d-be56-4bf3-a9f3-77f967079929" alt="WechatIMG119" width="300"> |
|
||||
|
||||
|
||||
## 🙏 Thanks to Contributors ✨
|
||||
|
||||
Thanks to all friends who have contributed to this project! (In no particular order)
|
||||
@@ -616,13 +683,10 @@ Thanks to all friends who have contributed to this project! (In no particular or
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
|
||||
### ✨ Special Thanks
|
||||
|
||||
| Contributors |
|
||||
| --- |
|
||||
| Contributors |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [<img src="https://avatars.githubusercontent.com/wanpengxie" width="100px;"><br>@wanpengxie](https://github.com/wanpengxie) |
|
||||
|
||||
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
|
||||
Reference in New Issue
Block a user