@deveco-codegenie/mcp-bridge-win32-x64 0.1.7 → 0.1.8-fix2

package/README.md

@@ -1,187 +1,42 @@
-# CodeGenie MCP Server
+# napi-bridge
 
-CodeGenie MCP Server 是一个专为 HarmonyOS 开发设计的 Model Context Protocol (MCP) 服务端。它旨在为 AI 辅助编程工具（如 Cursor, Trae 等）提供深度的 HarmonyOS 开发上下文感知能力，通过集成 DevEco Studio 环境信息和云端知识库，显著提升 HarmonyOS 应用开发的效率和准确性。
+将MCP Server封装成.node模块，无需经过 MCP 标准协议层（stdio），供 IDE 插件等 Node.js 宿主直接调用。
 
-## 主要特性
+---
 
-- **📚 HarmonyOS 知识库集成**
-  - 内置 `harmonyos_knowledge_search` 工具，直接对接云端知识库 API。
-  - 支持自然语言搜索 HarmonyOS 开发文档、API 参考和最佳实践。
-  - 智能检索相关代码片段和解决方案，辅助解决开发难题。
+## 目录
 
-- **🔧 DevEco Studio 深度整合**
-  - 自动检测本地 DevEco Studio 安装路径及 SDK 版本。
-  - 提供项目级上下文信息，包括工程结构、依赖关系等。
+- [工作原理](#工作原理)
+- [支持平台](#支持平台)
 
-- **🔌 灵活的扩展机制**
-  - 基于 Rust 实现的高性能 MCP 服务端。
-  - 提供 NPM 包装器，便于安装和集成到现有工作流中。
+---
 
-## 项目结构
+## 工作原理
 
-- `src-server/`: Rust 编写的 MCP 服务端核心逻辑。
-- `src-common/`: Rust 公共库，包含配置、日志、IPC 等通用模块。
-- `npm-wrapper/`: NPM 包封装，用于分发二进制文件。
-- `arkts-lang-server/`: ArkTS 语言服务相关组件。
-
-## 快速开始
-
-### 前置要求
-
-- Rust (用于编译后端)
-- Node.js & npm (用于构建前端)
-
-### 构建与运行
-
-1. **编译后端**
-   ```bash
-   cargo build --release
-   ```
-
-2. **运行服务**
-   ```bash
-   ./target/release/mcp-server
-   ```
-
-## 🧪 单元测试
-
-项目包含集成测试，用于验证与 DevEco Studio 和 ArkTS 语言服务的集成功能。由于这些测试依赖于本地开发环境，你需要配置环境属性文件。
-
-### 环境配置
-
-在 `src-server/tests/` 目录下，有两个环境配置文件模板：
-
-1.  **`deveco_env.properties`**: 用于测试与 DevEco Studio 的深度集成（如启动应用、获取 UI 树等）。
-    - `DEVECO_PATH`: DevEco Studio 的安装根目录。
-    - `EMULATOR_NAME`: 自动化测试使用的模拟器名称，默认为 "Mate 70 Pro"。
-
-2.  **`clt_env.properties`**: 用于测试与 HarmonyOS 命令行工具 (CLT) 的集成（如构建项目、代码检查等）。
-    - `CLT_PATH`: HarmonyOS Command Line Tools 的安装目录。
-    - `ARKTS_LANG_SERVER`: ArkTS 语言服务的可执行文件路径。
-    - `JAVA_HOME`: Java 运行时环境路径。
-
-**设置方式：**
-编辑上述文件，为每个键填入你本地环境的实际路径。例如：
-
-**`deveco_env.properties` 示例：**
-```properties
-DEVECO_PATH=D:\program_files\DevEco Studio
-EMULATOR_NAME=Mate 70 Pro
 ```
-
-**`clt_env.properties` 示例：**
-```properties
-CLT_PATH=D:\program_files\commandline-tools-windows-x64-6.0.2.640\command-line-tools
-ARKTS_LANG_SERVER=D:\program_files\DevEco Studio\plugins\openharmony
-JAVA_HOME=D:\program_files\DevEco Studio\jbr
+Node.js 宿主（IDE 插件等）
+       │
+       │  require("napi_bridge.<platform>-<arch>.node")
+       ▼
+  napi-bridge  ←──── Rust N-API 绑定
+       │
+       │  直接调用（无 stdio / MCP 协议）
+       ▼
+  mcp-server（Rust 核心库）
+       │
+       ▼
+  HarmonyOS 工具链（hvigor / hdc / ArkTS LSP ...）
 ```
 
-### 运行测试
-
-在根目录下运行以下命令执行所有测试：
-
-```bash
-cargo test
-```
-
-> **注意**：如果未设置 `DEVECO_PATH` 或 `CLT_PATH`，相关的集成测试将被跳过。
-
-## 🛠️ 辅助开发工具
-
-项目利用 `xtask` 模式提供了便捷的版本管理和分发构建工具。
-
-### 🧹 代码检查 (`cargo clippyall`)
-
-用于在本地开发环境中对支持的所有目标平台（Windows x64, macOS x64/arm64, Linux x64）运行 Clippy 静态检查。
-
-- **执行检查**：
-  ```bash
-  cargo clippyall
-  ```
-- **说明**：
-  该命令会自动安装所需的 Rust target（如果缺失），并依次对每个平台运行 `cargo clippy`，确保代码跨平台兼容性。
-
-### 🔢 版本更新 (`cargo bump`)
-
-用于同步更新项目中所有组件（Rust 核心、Common 库、ArkTS 语言服务、NPM 包装器）的版本号。
-
-- **更新版本**：
-  ```bash
-  cargo bump <new_version>
-  ```
-- **更新版本并自动提交**：
-  使用 `--commit` 参数会自动检查 Git 状态并在更新版本后创建 commit 和 tag。
-  ```bash
-  cargo bump <new_version> --commit
-  ```
-
-### 📋 变更日志 (`cargo changelog`)
-
-用于查看和生成项目的变更日志。支持灵活的范围指定，可以混合使用 tag 和 commit hash。
-
-- **查看最近两个版本的变更**（默认）：
-  ```bash
-  cargo changelog
-  ```
-- **查看指定范围的变更**：
-  ```bash
-  # 使用 tag
-  cargo changelog v0.1.0..v0.2.0
-  
-  # 使用 commit hash
-  cargo changelog abc123..def456
-  
-  # 混合使用（tag 和 hash）
-  cargo changelog v0.1.0..abc123      # tag 到 hash
-  cargo changelog def456..v0.2.0      # hash 到 tag
-  
-  # 使用 HEAD 查看未发布的变更
-  cargo changelog v0.2.0..HEAD        # 最新 tag 到当前 HEAD
-  ```
-
-### 📦 构建发布 (`cargo dist`)
+与 MCP stdio 传输不同，napi-bridge 通过 N-API 在**同一进程内**直接调用工具逻辑，省去了协议序列化与进程间通信开销。
 
-用于自动化构建多平台的二进制发布产物和 NPM 包。
 
-- **执行构建**：
-  ```bash
-  cargo dist
-  ```
-- **产物说明**：
-  构建结果存放在 `target/dist/` 目录，其典型的目录结构如下：
+---
 
-  ```text
-  target/dist/
-  ├── npm/
-  │   ├── codegenie-mcp-server/             # NPM 主包，用于分发和运行
-  │   │   ├── package.json                  # 定义 bin、dependencies 等
-  │   │   ├── index.js                      # 运行时自动检测平台并加载对应二进制
-  │   │   └── README.md
-  │   ├── codegenie-mcp-server-win32-x64/   # Windows (x64)
-  │   │   ├── bin/mcp-server.exe
-  │   │   ├── package.json
-  │   │   └── README.md
-  │   ├── codegenie-mcp-server-darwin-x64/  # macOS (Intel)
-  │   │   ├── bin/mcp-server
-  │   │   ├── package.json
-  │   │   └── README.md
-  │   ├── codegenie-mcp-server-darwin-arm64/ # macOS (Apple Silicon)
-  │   │   ├── bin/mcp-server
-  │   │   ├── package.json
-  │   │   └── README.md
-  │   └── codegenie-mcp-server-linux-x64/   # Linux (x64)
-  │       ├── bin/mcp-server
-  │       ├── package.json
-  │       └── README.md
-  ├── mcp-server-v{version}-{platform}.zip  # 平台压缩包
-  │   └── mcp-server/                       # 内部根目录
-  │       ├── mcp-server (or .exe)          # 可执行文件
-  │       ├── README.md                     # 项目说明
-  │       └── LICENSE                       # 授权协议
-  ├── mcp-server-v{version}-{triple}{ext}   # 原始二进制文件
-  └── arkts-lang-server-{version}.js        # 编译并混淆后的 ArkTS 语言服务脚本
-  ```
+## 支持平台
 
-  - **NPM 平台包**：通过 `optionalDependencies` 机制，实现在不同平台上自动安装正确的二进制文件。
-  - **ZIP 压缩包**：提供给不使用 NPM 的用户手动下载和集成。
-  - **ArkTS 语言服务**：独立打包的 JS 脚本，供 MCP 服务端调用以执行 ArkTS 相关的静态检查和分析。
+| 平台 | 架构 | Rust Target Triple |
+|------|------|--------------------|
+| Windows | x64 | `x86_64-pc-windows-msvc` |
+| macOS | x64 | `x86_64-apple-darwin` |
+| macOS | arm64 (Apple Silicon) | `aarch64-apple-darwin` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deveco-codegenie/mcp-bridge-win32-x64",
-  "version": "0.1.7",
+  "version": "0.1.8-fix2",
   "description": "@deveco-codegenie/mcp-bridge win32 native module",
   "os": [
     "win32"