You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project is a PTT MCP (Model Context Protocol) server based on the powerful [PyPtt](https://www.google.com/search?q=%5Bhttps://pyptt.cc/%5D(https://pyptt.cc/)) library. It enables your MCP client to genuinely log into PTT, interact with the PTT Bulletin Board System via the MCP protocol, and perform automated operations.
21
+
This is a PTT MCP (Model Context Protocol) server powered by the [`PyPtt`](https://pyptt.cc/) library. It enables any MCP client to authenticate with and interact directly with PTT bulletin board system, allowing for the automation of tasks through the MCP protocol.
20
22
21
23
## **🚀 Quick Start**
22
24
23
25
Using Docker is the most recommended way to deploy the PTT MCP Server, as it provides environment isolation and a simplified setup.
24
26
25
27
1. Install Docker:
26
-
If Docker is not already installed on your system, please refer to the official Docker documentation for installation instructions.
28
+
If Docker is not already installed on your system, please refer to the official [Docker](https://docs.docker.com/get-docker/) documentation for installation instructions.
27
29
2. Configure Your MCP Client:
28
-
Add the following configuration to your MCP client's settings file (e.g., ~/.gemini/settings.json). This setup allows the MCP client to automatically pull and run the Docker container when needed.
30
+
Add the following configuration to your MCP client's settings file (e.g., `~/.gemini/settings.json`). This setup allows the MCP client to automatically pull and run the Docker container when needed.
29
31
```json
30
32
{
31
33
"mcpServers": {
@@ -37,7 +39,7 @@ Using Docker is the most recommended way to deploy the PTT MCP Server, as it pro
37
39
"--rm",
38
40
"-e", "PTT_ID",
39
41
"-e", "PTT_PW",
40
-
"ghcr.io/PyPtt/ptt_mcp_server:latest"
42
+
"ghcr.io/pyptt/ptt_mcp_server:latest"
41
43
],
42
44
"env": {
43
45
"PTT_ID": "YOUR_PTT_ID", // Please replace with your PTT account ID
@@ -49,13 +51,13 @@ Using Docker is the most recommended way to deploy the PTT MCP Server, as it pro
49
51
```
50
52
51
53
**Explanation:**
52
-
* "command": "docker": Instructs the MCP client to use the docker command to start the server.
53
-
* "args": Contains the arguments for the docker run command.
54
-
*-i: Keeps standard input (stdin) open so the MCP server can receive commands.
55
-
* --rm: Automatically removes the container when it stops, keeping your system clean.
56
-
* -e PTT_ID and -e PTT_PW: Tells Docker to pass the PTT_ID and PTT_PW environment variables to the container.
57
-
* ghcr.io/PyPtt/ptt_mcp_server:latest: Specifies the Docker image to run.
58
-
*"env": Sets PTT_ID and PTT_PW directly as environment variables. **Be sure to replace these with your own PTT account ID and password.**
54
+
* "command": "docker": Instructs the MCP client to use the `docker` command to start the server.
55
+
* "args": Contains the arguments for the `docker run` command.
56
+
*`-i`: Keeps standard input (stdin) open so the MCP server can receive commands.
57
+
*`--rm`: Automatically removes the container when it stops, keeping your system clean.
58
+
*`-e PTT_ID` and `-e PTT_PW`: Tells Docker to pass the `PTT_ID` and `PTT_PW` environment variables to the container.
59
+
*`ghcr.io/PyPtt/ptt_mcp_server:latest`: Specifies the Docker image to run.
60
+
*`env`: Sets `PTT_ID` and `PTT_PW` directly as environment variables. **Be sure to replace these with your own PTT account ID and password.**
59
61
3. Launch and Test:
60
62
Your MCP client should now be able to start the PTT MCP server automatically. You can try a simple command, such as asking it to log into PTT, to test the connection.
61
63
@@ -79,7 +81,7 @@ Once your MCP client (e.g., Gemini CLI) is configured, you can interact with PTT
79
81
80
82
## **⚙️ How it Works**
81
83
82
-
This project acts as a middle layer. Your MCP client (e.g., Gemini CLI) connects to the locally running ptt-mcp-server. When the server receives a command, it connects to PTT through the [PyPtt](https://www.google.com/search?q=%5Bhttps://pyptt.cc/%5D(https://pyptt.cc/)) library, performs the corresponding action, and sends the result back to your client.
84
+
This project acts as a middle layer. Your MCP client (e.g., Gemini CLI) connects to the ptt-mcp-server running on your local machine. When the server receives a command, it uses the [`PyPtt`](https://pyptt.cc/) library to connect to PTT and execute the corresponding action, finally returning the result to your client.
0 commit comments