唯杰地图 logo唯杰地图
VJMAP
EN

install-and-mcp

vjcad/references/setup/install-and-mcp.md 1.9 KB58 行
原文

本文回答:vjcad 通过 npm install vjcad 安装;官方文档/示例 MCP 地址为 https://vjmap.com/server/aimcp/mcp?products=vjcad,可在 Trae、Cursor 等 AI 编辑器中接入。

一、环境要求

  • Node.js:16.0 或更高版本。
  • 包管理器:npm / yarn / pnpm 任选其一。
  • 浏览器:支持 WebGL 的现代浏览器(Chrome、Edge、Firefox、Safari 等)。

二、安装

# 新建项目(推荐 Vite + TypeScript)
npm create vite@latest my-webcad-app -- --template vanilla-ts
cd my-webcad-app
npm install vjcad
npm run dev

# 或:在已有项目中
npm install vjcad
yarn add vjcad
pnpm add vjcad

三、官方 MCP(可选)

VJCAD 提供官方 MCP(Model Context Protocol)服务,可在 AI 编辑器中接入用作开发辅助(官方 quick-start 给出的地址):

{
  "vjcad": {
    "url": "https://vjmap.com/server/aimcp/mcp?products=vjcad"
  }
}

注意与 https://vjmap.com/server/aicad/mcp(vjcad AI 助手服务,需要 token 鉴权)区分:文档/示例检索用 aimcp,AI 助手功能用 aicad。

四、推荐项目结构

my-webcad-app/
├── public/
│   └── fonts/              # 字体目录(见 setup/fonts;配置了 serviceUrl 时 fonts[].path 的相对路径会解析到 <服务根>/_webcad/,用这里的字体须写绝对 URL)
│       ├── simkai.woff
│       └── _default.shx
├── src/
│   ├── main.ts             # 入口,new MainView + initCadContainer
│   ├── commands/           # 自定义命令
│   └── plugins/            # 自定义插件
├── index.html              # 内含 <div id="cad-app"></div>
├── package.json
└── tsconfig.json

参考(官方文档 MCP)

  • 文档:vjcad/doc/guide/quick-start.md