README
🚀 钢琴 MCP 项目
本项目为钢琴 MCP 相关开发项目,提供了本地和云端两种运行模式,可用于与 Claude 桌面版等进行配置交互,同时提供了详细的安装、配置和使用说明。
🚀 快速开始
本地开发
若要在本地进行开发,可按以下步骤操作:
- 克隆仓库。
- 安装项目所需依赖:
npm install
- 构建项目:
npm run build
- 启动服务器:
npm start
📦 安装指南
本地模式
在本地模式下,按以下步骤进行配置:
- 设置
STEEL_LOCAL="true"。 - (可选)设置
STEEL_BASE_URL指向你自定义域名的 Steel 服务。若不设置,默认为http://localhost:3000。 - 无需 API Key。
- Puppeteer 连接地址:
ws://0.0.0.0:3000。
云端模式
在云端模式下,按以下步骤进行配置:
- 设置
STEEL_LOCAL="false"。 - 设置
STEEL_API_KEY以便 Steel Voyager 能够与云服务认证(或自托管的 Steel 实例)。 - 默认
STEEL_BASE_URL为https://api.steel.dev,如需更改请覆盖设置。 - Puppeteer 连接地址:
wss://connect.steel.dev?sessionId=…&apiKey=…。
配置 Claude 桌面版
在配置文件中添加类似以下内容(通常位于 ~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"steel-puppeteer": {
"command": "node",
"args": ["path/to/steel-puppeteer/dist/index.js"],
"env": {
"STEEL_LOCAL": "true",
"STEEL_API_KEY": "your_api_key_here"
}
}
}
}
根据需求调整环境变量:
- 本地或自托管:
"STEEL_LOCAL": "true",可选"STEEL_BASE_URL": "http://localhost:3000"。 - 云端:
"STEEL_LOCAL": "false",添加"STEEL_API_KEY": "<YourKey>"。
💻 使用示例
Claude 展示了其新功能,研究了最新的 Sorah 模型,并创建了一个交互式可视化来演示数据和工作原理。
⚠️ 重要提示
由于 GitHub 限制,视频文件大小不超过10MB。
📚 详细文档
常见问题
以下是一些常见问题及解决办法:
- 确保 Steel API Key 正确,云服务网络连通性正常。
- 添加延迟配置
GLOBAL_WAIT_SECONDS解决页面加载问题。 - 检查页面加载状态和视口尺寸设置。
- 手动释放会话避免资源泄漏。
- 合理提示以提升性能。
贡献指南
如果你想为项目做出贡献,可按以下步骤操作:
- 叉仓库。
- 创建功能分支。
- 提交拉取请求。
请在提交拉取请求时包含以下内容:
- 修改描述。
- 动机。
- 文档更新。
⚠️ 重要提示
该项目基于 Web Voyager 代码库,尚处于实验阶段,请勿在生产环境中使用。
Scan to join WeChat group