@demowaymcp Server

🚀 @demoway/mcp-server

DemoWay MCP 服務器實現，提供標準化的 Model Context Protocol (MCP) 接口服務，助力開發者高效使用相關功能。

✨ 主要特性

• search_demo_step：通過關鍵詞在演示中搜索步驟。
• download_demo_step_pretty_html：下載演示步驟的精美 HTML。

🚀 快速開始

📦 安裝指南

本地開發配置

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>"
      }
    }
  }
}

通用配置

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

💻 使用示例

基礎用法

本項目提供了兩個實用工具，以下是簡單的使用說明：

• search_demo_step：可通過關鍵詞在演示中搜索步驟。
• download_demo_step_pretty_html：用於下載演示步驟的精美 HTML。

高級用法

在實際使用中，可根據不同的配置文件進行靈活調用，如上述安裝指南中的配置內容，可根據自身需求進行調整。

🤝 貢獻

歡迎提交拉取請求。請確保：

1. 代碼遵循 ESLint 規則。
2. 添加適當的測試用例。
3. 使用 Commitizen 進行提交信息管理。

📄 許可證

MIT © DemoWay