Skip to content

Commit a074d55

Browse files
committed
📝 Update readme about mcp
issue #64
1 parent 733f283 commit a074d55

File tree

2 files changed

+34
-7
lines changed

2 files changed

+34
-7
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Yutu](./asset/yutu.svg)
22

3-
# yutu
3+
# `yutu`
44

55
[![Static Badge](https://img.shields.io/badge/gitmoji-%F0%9F%98%BF%F0%9F%90%B0%F0%9F%90%A7%E2%9D%A4%EF%B8%8F%E2%80%8D%F0%9F%A9%B9-love?style=flat-square&labelColor=%23EDD1CC&color=%23FF919F)](https://gitmoji.dev)
66
[![Go Report Card](https://goreportcard.com/badge/github.com/eat-pray-ai/yutu?style=flat-square)](https://goreportcard.com/report/github.com/eat-pray-ai/yutu)
@@ -19,7 +19,7 @@
1919

2020
[![yutu - build a fully automated YouTube Channel!](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=490920&theme=light)](https://www.producthunt.com/posts/yutu?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-yutu)
2121

22-
yutu is a fully functional CLI for YouTube.
22+
`yutu` is a fully functional MCP server and CLI for YouTube.
2323

2424
## Prerequisites
2525

@@ -77,7 +77,7 @@ By default, `yutu` will read `client_secret.json` and `youtube.token.json` from
7777

7878
## Installation
7979

80-
You can download yutu from [releases page](https://github.com/eat-pray-ai/yutu/releases/latest) directly, or use the following methods as you prefer.
80+
You can download `yutu` from [releases page](https://github.com/eat-pray-ai/yutu/releases/latest) directly, or use the following methods as you prefer.
8181

8282
### GitHub Actions
8383

@@ -136,11 +136,37 @@ Verify the integrity and provenance of `yutu` using its associated cryptographic
136136
❯ gh attestation verify $(where.exe yutu.exe) --repo eat-pray-ai/yutu
137137
```
138138

139+
## MCP Server
140+
141+
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=yutu&config=%7B%22type%22%3A%20%22stdio%22%2C%22command%22%3A%20%22yutu%22%2C%22args%22%3A%20%5B%22mcp%22%5D%2C%22env%22%3A%20%7B%22YUTU_CREDENTIAL%22%3A%20%22%2Fabsolute%2Fpath%2Fto%2Fclient_secret.json%22%2C%22YUTU_CACHE_TOKEN%22%3A%20%22%2Fabsolute%2Fpath%2Fto%2Fyoutube.token.json%22%7D%7D)
142+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=yutu&config=JTdCJTIyY29tbWFuZCUyMiUzQSUyMnl1dHUlMjBtY3AlMjIlMkMlMjJlbnYlMjIlM0ElN0IlMjJZVVRVX0NSRURFTlRJQUwlMjIlM0ElMjIlMkZhYnNvbHV0ZSUyRnBhdGglMkZ0byUyRmNsaWVudF9zZWNyZXQuanNvbiUyMiUyQyUyMllVVFVfQ0FDSEVfVE9LRU4lMjIlM0ElMjIlMkZhYnNvbHV0ZSUyRnBhdGglMkZ0byUyRnlvdXR1YmUudG9rZW4uanNvbiUyMiU3RCU3RA%3D%3D)
143+
144+
As a [MCP server](https://modelcontextprotocol.io/introduction), `yutu` can be used in MCP clients like [Claude Desktop](https://modelcontextprotocol.io/quickstart/user), [VS Code](https://code.visualstudio.com/) or [Cursor](https://docs.cursor.com/), which allows you to interact with YouTube resources in a chat-like interface.
145+
146+
Before using `yutu` as an MCP server, make sure `yutu` is installed(see [Installation](#installation) section), and you have a valid `client_secret.json` and `youtube.token.json` files(refer to [Prerequisites](#prerequisites) section).
147+
148+
You can add `yutu` as a MCP server in VS Code or Cursor by clicking corresponding badge above, or add the following configuration manually to your MCP client. Remember to replace the values of `YUTU_CREDENTIAL` and `YUTU_CACHE_TOKEN` with correct paths on your local machine.
149+
150+
```json
151+
{
152+
"yutu": {
153+
"type": "stdio",
154+
"command": "yutu",
155+
"args": [
156+
"mcp"
157+
],
158+
"env": {
159+
"YUTU_CREDENTIAL": "/absolute/path/to/client_secret.json",
160+
"YUTU_CACHE_TOKEN": "/absolute/path/to/youtube.token.json"
161+
}
162+
}
163+
}
164+
```
165+
139166
## Usage
140167

141168
```shell
142-
❯ yutu help
143-
yutu is a fully functional CLI for YouTube, which can be used to manipulate YouTube videos, playlists, channels, etc
169+
❯ yutu is a fully functional MCP server and CLI for YouTube, which can manipulate almost all YouTube resources
144170

145171
Usage:
146172
yutu [flags]
@@ -159,6 +185,7 @@ Available Commands:
159185
help Help about any command
160186
i18nLanguage List YouTube i18n languages
161187
i18nRegion List YouTube i18n regions
188+
mcp Start MCP server
162189
member List channel's members' info
163190
membershipsLevel List memberships levels' info
164191
playlist Manipulate YouTube playlists

cmd/root.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import (
88
)
99

1010
const (
11-
short = "A fully functional CLI for YouTube"
12-
long = "yutu is a fully functional CLI for YouTube, which can be used to manipulate YouTube videos, playlists, channels, etc"
11+
short = "A fully functional MCP server and CLI for YouTube"
12+
long = "yutu is a fully functional MCP server and CLI for YouTube, which can manipulate almost all YouTube resources"
1313
)
1414

1515
var RootCmd = &cobra.Command{

0 commit comments

Comments
 (0)