buttplug-mcp

🚀 但tplug-mcp项目文档

这个项目是一个基于Golang的工具，它将Model Context Protocol (MCP) 与Buttplug协议相结合。借助该工具，可通过MCP协议与Buttplug设备进行交互，实现设备振动功能。

🚀 快速开始

本项目允许通过MCP协议与Buttplug设备交互，提供设备振动功能。以下将为你介绍安装、使用等相关内容。

✨ 主要特性

• 支持通过MCP协议与Buttplug设备通信。
• 提供设备振动功能，支持指定设备ID、强度和可选电机。
• 提供完整的文档和示例说明。

📦 安装指南

依赖管理

使用Go模块进行管理。运行以下命令初始化项目：

go mod init your-project-name
go mod tidy

构建

使用 task 工具进行构建和测试：

$ task

💻 使用示例

运行时选项

usage: buttplug-mcp [opts]

  -h, --help              显示帮助信息
  -l, --log-file string   指定日志文件路径（或 MCP_LOG_FILE 环境变量）。默认为标准错误输出
  -j, --log-json          使用 JSON 格式记录日志（默认为文本格式）
      --sse               使用 SSE 运输协议（默认为 STDIO 运输协议）
      --sse-host string   指定 SSE 连接的主机和端口
  -v, --verbose           启用详细日志输出
      --ws-port int       指定连接到 Buttplug WebSocket 服务器的端口号

基础用法

1. 使用默认配置运行：

$ buttplug-mcp

高级用法

2. 指定 WebSocket 端口：

$ buttplug-mcp --ws-port 8080

🤝 工具贡献

贡献指南

欢迎 fork 或提交 pull request。请遵守我们的 行为准则，保持专业，但不要无理取闹。

📄 许可证

© 2025 Neomantra BV。由 Evan Wies 为 ConAcademy 撰写。

本项目在 MIT 许可证下发布，具体见 LICENSE.txt。

参考资料

• 借鉴了 go-buttplug 的 Golang Buttplug.io 库 和其 buttplughttp 示例
• 借鉴了 go-mcp 的 Golang Model Context Protocol 库