Content
<p align="center">
<a href="https://www.github.com/hoshinonyaruko/gensokyo">
<img src="images/head.gif" width="200" height="200" alt="gensokyo">
</a>
</p>
<div align="center">
# Tool List
_✨ Based on [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md) MCP-Onebot Robot API Golang Native Implementation ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/hoshinonyaruko/gensokyo-mcp/main/LICENSE">
<img src="https://img.shields.io/github/license/hoshinonyaruko/gensokyo" alt="license">
</a>
<a href="https://github.com/hoshinonyaruko/gensokyo-mcp/releases">
<img src="https://img.shields.io/github/v/release/hoshinonyaruko/gensokyo?color=blueviolet&include_prereleases" alt="release">
</a>
<a href="https://github.com/howmanybots/onebot/blob/master/README.md">
<img src="https://img.shields.io/badge/OneBot-v11-blue?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="gensokyo">
</a>
<a href="https://github.com/hoshinonyaruko/gensokyo-mcp/actions">
<img src="images/badge.svg" alt="action">
</a>
<a href="https://goreportcard.com/report/github.com/hoshinonyaruko/gensokyo">
<img src="https://goreportcard.com/badge/github.com/hoshinonyaruko/gensokyo" alt="GoReportCard">
</a>
</p>
<p align="center">
<a href="https://github.com/howmanybots/onebot/blob/master/README.md">Documentation</a>
·
<a href="https://github.com/hoshinonyaruko/gensokyo-mcp/releases">Download</a>
·
<a href="https://github.com/hoshinonyaruko/gensokyo-mcp/releases">Getting Started</a>
·
<a href="https://github.com/hoshinonyaruko/gensokyo-mcp/blob/master/CONTRIBUTING.md">Contribute</a>
</p>
<p align="center">
<a href="https://gensokyo.bot">Project Homepage: gensokyo.bot</a>
</p>
### Compatibility
**gensokyo** is compatible with [OneBot-v11](https://github.com/botuniverse/onebot-11). For more information, please refer to the OneBot official documentation.
It supports connecting to OneBot-v11 standard robot's reverse WebSocket as MCP Server.
The following projects can be seamlessly connected, including:
* koishi
* nonebot2
* trss
* zerobot
* MiraiCQ
* hoshino
* tata
* Paimon
* Zha Mao
* Sanae
* Shoujo
* Yobot
* Mirai (Overflow)
* And other projects that support OneBot-v11 protocol
At the same time, **gensokyo** supports connecting to VScode-Cline, Claude, OpenAI, and various MCP-enabled application platforms, and can be used in conjunction with other projects that support OneBot-v11 adapters.
Developers and users do not need to redevelop plugins and can directly reuse existing plugins and experiences in the ecosystem.
The project is continuously being improved. Welcome to join the discussion group (196173384) to participate in testing or discuss usage issues. Feel free to ask questions, and we will promptly answer and assist you.
### Main Purpose
* Developer testing
* Screenshot display
* Personal entertainment
* Tool usage and efficiency expansion
### MCP Service Usage
**Step 1: Start the service**
After running gensokyo, the project will automatically release the `config.yml` configuration file.
**Step 2: Configure connection parameters**
In `config.yml`, set the OneBot-v11 reverse WebSocket address to be connected.
For example, using cline, the configuration is as follows. Note that the `/sse/sse` path appears twice, ensuring the address is filled in correctly:
```json
{
"mcpServers": {
"gensokyo-mcp": {
"autoApprove": [
"call_ws"
],
"disabled": false,
"timeout": 30,
"url": "http://127.0.0.1:8090/sse/sse",
"transportType": "sse"
}
}
}
```
* Supports local connections (as shown in the example) and remote connections. Just replace `url` with the corresponding address.
* For other MCP client connection methods, you can directly copy the cline configuration template, modify the parameters, and use it. If you have questions, feel free to send the configuration to the discussion group or ask AI for targeted help.
## Tutorial Index
> [💙 Windows VSCode-Cline + gensokyo-mcp Sanae Access Complete Tutorial](./doc/sanae.md)
**Frequently Asked Questions**
If you encounter connection anomalies or configuration-related issues, please join the discussion group 196173384 for feedback, and we will assist you in quickly resolving the issue.
### Example Images (Connected to Shoujo Plugin)
<div align="center">
<img src="images/example1.png" alt="Example Image" width="60%" />
<p>Example 1: Shoujo Plugin Interface</p>
<img src="images/example2.png" alt="Example Image" width="60%" />
<p>Example 2: Effect</p>
* Any OneBotv11 plugin type, such as weather, game query, entertainment, can be used as an MCP Server. Immediately convert thousands of OneBotv11 ecological plugins into AI tools
</div>
### Interface
Since this project is reconstructed from gensokyo-wxmp, it currently only supports passing text and only supports reverse WS connection to OneBotv11 robot applications.
- [] HTTP API
- [] Reverse HTTP POST
- [] Forward WebSocket
- [x] Reverse WebSocket
### Extended Support
> For extended API, please refer to [Documentation](docs/cqhttp.md)
- [x] Connect multiple WS addresses
- [x] Virtual MCP user information as group events/private chat events
- [x] Continuous updates~
### Implementation
<details>
<summary>Implemented API</summary>
#### OneBot Standard API
| API | Function |
| ------------------------ | ---------------------- |
| /send_group_msg√ | [Send MCP reply message] |
</details>
<details>
<summary>Implemented Event</summary>
#### OneBot Standard Event (some events have more fields than OneBot standard, but do not affect usage)
| Event Type | Event |
| -------- | ---------------- |
| Message Event | [MCP Information Virtual Private Chat Information]TODO |
| Message Event | [MCP Information Virtual Group Message] |
</details>
## About ISSUE
The following ISSUE will be directly closed
- Submit BUG without using Template
- Ask known questions
- Ask questions that are hard to understand
- Repeat questions
> Please note that developers are not obligated to respond to your questions. You should have basic questioning skills.
> For how to ask questions, please read [The Art of Asking Questions](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)
## Performance
10mb memory usage, ports can be opened multiple times, stable operation without errors
