Skip to content

Commit 2808172

Browse files
authored
Merge pull request #27 from jkawamoto/readme
Update and improve README documentation
2 parents b45d58a + b760fbe commit 2808172

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
55
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
66
[![smithery badge](https://smithery.ai/badge/@jkawamoto/mcp-youtube-transcript)](https://smithery.ai/server/@jkawamoto/mcp-youtube-transcript)
7+
[![Dockerhub](https://img.shields.io/badge/Docker-mcp%2Fyoutube--transcript-blue.svg)](https://hub.docker.com/mcp/server/youtube_transcript)
78

89
This MCP server retrieves transcripts for given YouTube video URLs.
910

@@ -20,33 +21,12 @@ Fetches the transcript of a specified YouTube video.
2021
- **lang** *(string, optional)*: The desired language for the transcript. Defaults to `en` if not specified.
2122

2223
## Installation
24+
> [!NOTE]
25+
> You'll need [`uv`](https://docs.astral.sh/uv) installed on your system to use `uvx` command.
2326
24-
### For Goose CLI
25-
To enable the YouTube Transcript extension in Goose CLI,
26-
edit the configuration file `~/.config/goose/config.yaml` to include the following entry:
27-
28-
```yaml
29-
extensions:
30-
youtube-transcript:
31-
name: Youtube Transcript
32-
cmd: uvx
33-
args: [--from, git+https://github.com/jkawamoto/mcp-youtube-transcript, mcp-youtube-transcript]
34-
enabled: true
35-
type: stdio
36-
```
37-
38-
### For Goose Desktop
39-
Add a new extension with the following settings:
40-
41-
- **Type**: Standard IO
42-
- **ID**: youtube-transcript
43-
- **Name**: Youtube Transcript
44-
- **Description**: Retrieve transcripts of YouTube videos
45-
- **Command**: `uvx --from git+https://github.com/jkawamoto/mcp-youtube-transcript mcp-youtube-transcript`
46-
47-
For more details on configuring MCP servers in Goose Desktop,
48-
refer to the documentation:
49-
[Using Extensions - MCP Servers](https://block.github.io/goose/docs/getting-started/using-extensions#mcp-servers).
27+
### For codename goose
28+
Please refer to this tutorial for detailed installation instructions:
29+
[YouTube Transcript Extension](https://block.github.io/goose/docs/mcp/youtube-transcript-mcp).
5030

5131
### For Claude Desktop
5232
To configure this server for Claude Desktop, edit the `claude_desktop_config.json` file with the following entry under
@@ -70,13 +50,24 @@ After editing, restart the application.
7050
For more information,
7151
see: [For Claude Desktop Users - Model Context Protocol](https://modelcontextprotocol.io/quickstart/user).
7252

73-
#### Installing via Smithery
74-
To install Youtube Transcript for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@jkawamoto/mcp-youtube-transcript):
53+
### Installing via Smithery
54+
The [Smithery CLI](https://github.com/smithery-ai/cli) enables the installation of MCP servers on various clients.
55+
56+
For instance, to install this server for Claude Desktop, execute the following command:
7557

7658
```bash
7759
npx -y @smithery/cli install @jkawamoto/mcp-youtube-transcript --client claude
7860
```
7961

62+
To view the list of clients supported by the Smithery CLI, use this command:
63+
64+
```bash
65+
npx -y @smithery/cli list clients
66+
```
67+
68+
Refer to the [Smithery CLI documentation](https://github.com/smithery-ai/cli) for additional details.
69+
70+
8071
## Using Proxy Servers
8172
In environments where access to YouTube is restricted, you can use proxy servers.
8273

0 commit comments

Comments
 (0)