{"_id":"@blueking/bk-weweb-mcp","_rev":"2-4ad4522649a81d24deb4408f33194261","name":"@blueking/bk-weweb-mcp","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@blueking/bk-weweb-mcp","version":"1.0.0","keywords":["mcp","model-context-protocol","bk-weweb","micro-frontend","blueking"],"author":{"name":"BlueKing"},"license":"MIT","_id":"@blueking/bk-weweb-mcp@1.0.0","maintainers":[{"name":"blueking-magicbox","email":"contactus_bk@tencent.com"}],"bin":{"bk-weweb-mcp":"dist/index.js","bk-weweb-mcp-sse":"dist/index.js","bk-weweb-mcp-stdio":"dist/stdio.js"},"dist":{"shasum":"cbd62512304845815632d0dc85ab09784c771d6f","tarball":"https://registry.npmjs.org/@blueking/bk-weweb-mcp/-/bk-weweb-mcp-1.0.0.tgz","fileCount":30,"integrity":"sha512-aIaMnF0QGc5Ffq2AGT1NPBtOHTqP3zgO6oMv6UWL0vmFjaPWC4jNOA+NSBdD0FwywHWkIkbG2sK2rAFSGEvg0A==","signatures":[{"sig":"MEYCIQD/S8c5YBoVAsd/xcIBMyxePyQAUGkvpCnQogN/zJLoKQIhAK9yjPGd7U7UM82Q05sda3YKIhW7mFO8+rWyiOSWcYVE","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":117135},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=22.0.0"},"gitHead":"88b8743ef6dcf39181146466927e010c95be2cd0","scripts":{"dev":"tsx watch src/index.ts","build":"tsc","start":"node dist/index.js","dev:stdio":"tsx watch src/stdio.ts","start:stdio":"node dist/stdio.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"blueking-magicbox","email":"contactus_bk@tencent.com"},"_npmVersion":"11.7.0","description":"MCP Server for BK-WeWeb micro-frontend framework","directories":{},"_nodeVersion":"22.20.0","dependencies":{"zod":"^4.3.5","express":"^4.22.1","@modelcontextprotocol/sdk":"^1.25.3"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","typescript":"^5.3.0","@types/node":"^22.19.7","@types/express":"^4.17.25"},"_npmOperationalInternal":{"tmp":"tmp/bk-weweb-mcp_1.0.0_1768996099087_0.9586459759637944","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@blueking/bk-weweb-mcp","version":"1.0.1","description":"MCP Server for BK-WeWeb micro-frontend framework","main":"dist/index.js","type":"module","bin":{"bk-weweb-mcp":"dist/index.js","bk-weweb-mcp-sse":"dist/index.js","bk-weweb-mcp-stdio":"dist/stdio.js"},"scripts":{"build":"tsc","dev":"tsx watch src/index.ts","dev:stdio":"tsx watch src/stdio.ts","start":"node dist/index.js","start:stdio":"node dist/stdio.js","prepublishOnly":"npm run build"},"keywords":["bk-weweb-mcp","bk-weweb","@blueking/bk-weweb-mcp","blueking"],"author":{"name":"BlueKing"},"license":"MIT","dependencies":{"@modelcontextprotocol/sdk":"^1.25.3","express":"^4.22.1","zod":"^4.3.5"},"devDependencies":{"@types/express":"^4.17.25","@types/node":"^22.19.7","tsx":"^4.7.0","typescript":"^5.3.0"},"engines":{"node":">=22.0.0"},"gitHead":"f733cdeceaf67caeb6bc7ffe60438209a57fd38f","types":"./dist/index.d.ts","_id":"@blueking/bk-weweb-mcp@1.0.1","_nodeVersion":"22.20.0","_npmVersion":"11.7.0","dist":{"integrity":"sha512-ukJbThFa8gRnJMmoydqTlY/0YBQvCdZjbjfvKyZL5racp11B6qv8oQaAlTXMqcgvJ+Q4Fu+z3r5Dwx0AJ47IVg==","shasum":"eda0865a02e44dc3a7494328d6cf65105114253c","tarball":"https://registry.npmjs.org/@blueking/bk-weweb-mcp/-/bk-weweb-mcp-1.0.1.tgz","fileCount":30,"unpackedSize":117122,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCwwyV1Gl4T7YDytZ2PMup59LElP1YvCUqtNNUs4nb0BQIhANi+XzQZYLC2aueYd0QX8BY0DFC3Wbnru3GEIjHE7JrU"}]},"_npmUser":{"name":"blueking-magicbox","email":"contactus_bk@tencent.com"},"directories":{},"maintainers":[{"name":"blueking-magicbox","email":"contactus_bk@tencent.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bk-weweb-mcp_1.0.1_1769051567571_0.16037806057337156"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-21T11:48:18.989Z","modified":"2026-01-22T03:12:47.857Z","1.0.0":"2026-01-21T11:48:19.233Z","1.0.1":"2026-01-22T03:12:47.723Z"},"author":{"name":"BlueKing"},"license":"MIT","keywords":["bk-weweb-mcp","bk-weweb","@blueking/bk-weweb-mcp","blueking"],"description":"MCP Server for BK-WeWeb micro-frontend framework","maintainers":[{"name":"blueking-magicbox","email":"contactus_bk@tencent.com"}],"readme":"# BK-WeWeb MCP Server\n\n为 BK-WeWeb 微前端框架提供 MCP (Model Context Protocol) 服务，让 AI 助手能够更好地帮助开发者使用 BK-WeWeb。\n\n## 功能特性\n\n- 📚 **文档查询**: 快速获取 BK-WeWeb 各模块的文档\n- 🔧 **代码生成**: 生成微应用/微模块的配置和集成代码\n- ✅ **配置校验**: 验证配置是否正确，提供优化建议\n- 📖 **示例代码**: 获取各种使用场景的完整示例\n- 🌐 **双模式支持**: 支持 SSE (HTTP) 和 Stdio 两种传输方式\n\n## 安装与配置\n\n### 方式一：使用 npx（推荐，无需安装）\n\n直接在 Cursor 或 Claude Desktop 中配置，无需预先安装。\n\n#### Cursor 配置\n\n编辑 `~/.cursor/mcp.json`：\n\n**Stdio 模式（推荐）**：\n\n```json\n{\n  \"mcpServers\": {\n    \"bk-weweb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"-p\", \"@blueking/bk-weweb-mcp\", \"bk-weweb-mcp-stdio\"]\n    }\n  }\n}\n```\n\n**SSE 模式**：\n\n```json\n{\n  \"mcpServers\": {\n    \"bk-weweb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@blueking/bk-weweb-mcp\"]\n    }\n  }\n}\n```\n\n#### Claude Desktop 配置\n\n编辑 `~/Library/Application Support/Claude/claude_desktop_config.json`：\n\n```json\n{\n  \"mcpServers\": {\n    \"bk-weweb\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"-p\", \"@blueking/bk-weweb-mcp\", \"bk-weweb-mcp-stdio\"]\n    }\n  }\n}\n```\n\n### 方式二：本地开发安装\n\n```bash\ncd mcp-server\npnpm install\npnpm run build\n```\n\n**Stdio 模式**：\n\n```json\n{\n  \"mcpServers\": {\n    \"bk-weweb\": {\n      \"command\": \"node\",\n      \"args\": [\"/path/to/bk-weweb/mcp-server/dist/stdio.js\"]\n    }\n  }\n}\n```\n\n**SSE 模式**（先运行 `pnpm start` 启动服务器）：\n\n```json\n{\n  \"mcpServers\": {\n    \"bk-weweb\": {\n      \"url\": \"http://localhost:3100/sse\"\n    }\n  }\n}\n```\n\n---\n\n## 命令行使用\n\n### SSE 模式（HTTP 服务器）\n\n```bash\n# 使用 npx\nnpx @blueking/bk-weweb-mcp\n\n# 指定端口\nPORT=8080 npx @blueking/bk-weweb-mcp\n\n# 本地开发\npnpm start\n```\n\n启动后可访问：\n\n- `http://localhost:3100/` - 服务器信息\n- `http://localhost:3100/health` - 健康检查\n- `http://localhost:3100/sse` - SSE 连接端点\n- `http://localhost:3100/messages` - 消息处理端点\n\n### Stdio 模式\n\n```bash\n# 使用 npx\nnpx -y -p @blueking/bk-weweb-mcp bk-weweb-mcp-stdio\n\n# 本地开发\npnpm start:stdio\n```\n\n## 可用工具\n\n### 文档查询\n\n| 工具                 | 说明                    |\n| -------------------- | ----------------------- |\n| `list_bk_weweb_docs` | 列出所有可用文档主题    |\n| `get_bk_weweb_docs`  | 获取特定主题的文档      |\n| `get_api_reference`  | 获取特定 API 的详细文档 |\n\n**支持的文档主题**:\n\n- `introduction` - 简介\n- `quick-start` - 快速上手\n- `micro-app` - 微应用模式\n- `micro-module` - 微模块模式\n- `hooks` - Hooks API\n- `api` - API 参考\n- `preload` - 预加载\n- `shadow-dom` - Shadow DOM\n- `keep-alive` - 缓存模式\n\n### 代码生成\n\n| 工具                         | 说明                |\n| ---------------------------- | ------------------- |\n| `generate_micro_app_code`    | 生成微应用配置代码  |\n| `generate_micro_module_code` | 生成微模块配置代码  |\n| `generate_vue_integration`   | 生成 Vue 3 集成代码 |\n| `generate_react_integration` | 生成 React 集成代码 |\n\n### 配置校验\n\n| 工具                          | 说明               |\n| ----------------------------- | ------------------ |\n| `validate_weweb_config`       | 校验配置是否正确   |\n| `check_browser_compatibility` | 检查浏览器兼容性   |\n| `get_cors_config`             | 获取 CORS 配置指南 |\n\n### 示例代码\n\n| 工具               | 说明                   |\n| ------------------ | ---------------------- |\n| `list_examples`    | 列出所有示例           |\n| `get_example_code` | 获取特定场景的示例代码 |\n\n**支持的示例场景**:\n\n- `basic-app` - 基础微应用\n- `basic-module` - 基础微模块\n- `data-passing` - 数据传递\n- `keep-alive` - KeepAlive 缓存\n- `preload` - 预加载\n- `shadow-dom` - Shadow DOM\n- `scope-location` - 路由隔离\n- `custom-container` - 自定义容器\n- `multi-framework` - 多框架共存\n- `error-handling` - 错误处理\n\n## 使用示例\n\n### 查询文档\n\n```\n请帮我查看 BK-WeWeb 的快速上手文档\n```\n\n### 生成代码\n\n```\n帮我生成一个 Vue 3 项目集成微应用的代码，应用 ID 是 dashboard，URL 是 http://localhost:8001/\n```\n\n### 校验配置\n\n```\n帮我检查这个配置是否正确：\n{\n  \"url\": \"http://localhost:8001/\",\n  \"id\": \"my-app\",\n  \"scopeJs\": true,\n  \"scopeCss\": true\n}\n```\n\n### 获取示例\n\n```\n给我一个 KeepAlive 缓存模式的完整示例\n```\n\n## 开发\n\n```bash\n# 安装依赖\npnpm install\n\n# 开发模式 (SSE)\npnpm dev\n\n# 开发模式 (Stdio)\npnpm dev:stdio\n\n# 构建\npnpm build\n\n# 运行 SSE 服务器\npnpm start\n\n# 运行 Stdio 服务器\npnpm start:stdio\n```\n\n## API 端点 (SSE 模式)\n\n| 端点        | 方法 | 说明             |\n| ----------- | ---- | ---------------- |\n| `/`         | GET  | 服务器信息       |\n| `/health`   | GET  | 健康检查         |\n| `/sse`      | GET  | 建立 SSE 连接    |\n| `/messages` | POST | 发送消息到服务器 |\n\n## 环境变量\n\n| 变量   | 默认值 | 说明           |\n| ------ | ------ | -------------- |\n| `PORT` | 3100   | SSE 服务器端口 |\n\n## 许可证\n\nMIT\n","readmeFilename":"README.md"}