@demowaymcp Server

🚀 @demoway/mcp-server

DemoWay MCP 服务器实现，提供标准化的 Model Context Protocol (MCP) 接口服务。借助该服务器，可利用其提供的工具进行演示步骤的搜索和精美 HTML 下载。

🚀 快速开始

已提供的工具

• search_demo_step：通过关键词在演示中搜索步骤
• download_demo_step_pretty_html：下载演示步骤的精美 HTML

使用方法

配置

{
  "mcpServers": {
    "demoway": {
      "command": "npx",
      "args": ["-y", "@demoway/mcp-server@latest", "--region={world,china}"],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

本地开发

1. 全局安装 tsx

pnpm --global install tsx

2. 配置 MCP 客户端

{
  "mcpServers": {
    "demoway": {
      "command": "tsx",
      "args": ["<ABSOLUTE_PATH_TO_SRC_INDEX_FILE>", "--url=http://localhost:3333"],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

✨ 主要特性

• 提供标准化的 Model Context Protocol (MCP) 接口服务。
• 具备搜索演示步骤和下载精美 HTML 的工具。

📦 安装指南

全局安装 tsx

pnpm --global install tsx

💻 使用示例

基础用法

配置 MCP 服务器：

{
  "mcpServers": {
    "demoway": {
      "command": "npx",
      "args": ["-y", "@demoway/mcp-server@latest", "--region={world,china}"],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

高级用法

本地开发时配置 MCP 客户端：

{
  "mcpServers": {
    "demoway": {
      "command": "tsx",
      "args": ["<ABSOLUTE_PATH_TO_SRC_INDEX_FILE>", "--url=http://localhost:3333"],
      "env": {
        "DEMOWAY_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}

🤝 贡献

欢迎提交拉取请求。请确保：

1. 代码遵循 ESLint 规则
2. 添加适当的测试用例
3. 使用 Commitizen 进行提交信息管理

📄 许可证

MIT © DemoWay