AI 助手接入

让 Claude Code、codex、Gemini CLI、Kimi、Qwen、DeepSeek、GLM、MiniMax、Grok 等 AI 助手直接调用 CityEngine / CGA.js / NL2CGA:自然语言生成 CGA 规则 → 编译三维模型(GLB)→ 官方引擎对齐验证。

三种接入方式
方式适用助手说明
A. MCP stdio(推荐)Claude Code · codex · Gemini CLI · Kimi Code · Qwen Code · Cursor · Cline · Cherry Studiopip install cityvistion-mcp,11 个工具即装即用
B. MCP 托管端点支持远程 MCP(HTTP)的客户端https://mcp.cgajs.com/mcp,免安装,key 走请求头
C. Function-calling / RESTDeepSeek · GLM · MiniMax · Grok · Kimi(Moonshot API) · 自研智能体按 OpenAPI / function-tools 直接调 REST

统一 API key:一个 key 三项目通用。NL2CGA 用 Authorization: Bearer,CGA.js 用 x-api-key,CityEngine 用 X-API-Key;MCP 方式只需配置 CITYVISTION_API_KEY 环境变量,工具内部自动分流。Key 在各站用户中心领取。

11 个工具

nl2cga generate_cga / get_job cgajs compile_cga / get_quota cityengine parse_cga / generate_cga / generate_model / get_job / get_quota 免key inspect_cga / list_demos / get_demo

A. MCP stdio 配置

先安装:pip install cityvistion-mcp(PyPI 已上架,Python ≥ 3.10),然后按你的客户端选一段配置,把 你的key 替换为统一 API key。

Claude Code(GLM Coding 同)

项目根目录 .mcp.json:

{
  "mcpServers": {
    "cityvistion": {
      "command": "python3",
      "args": ["-m", "cityvistion_mcp.server"],
      "env": { "CITYVISTION_API_KEY": "你的key" }
    }
  }
}

codex(OpenAI)

~/.codex/config.toml:

[mcp_servers.cityvistion]
command = "python3"
args = ["-m", "cityvistion_mcp.server"]
env = { CITYVISTION_API_KEY = "你的key" }

Gemini CLI · Qwen Code

一键安装(推荐):gemini extensions install https://github.com/cgajs/cityvistion-mcp(官方扩展,托管端点零安装,安装时输入统一 key 即可)。或手动配置:

~/.gemini/settings.json(Qwen Code 为 ~/.qwen/settings.json,同 schema):

{
  "mcpServers": {
    "cityvistion": {
      "command": "python3",
      "args": ["-m", "cityvistion_mcp.server"],
      "env": { "CITYVISTION_API_KEY": "你的key" }
    }
  }
}

Kimi Code

~/.kimi-code/mcp.json(用户级)或项目级 .kimi-code/mcp.json:

{
  "mcpServers": {
    "cityvistion": {
      "command": "python3",
      "args": ["-m", "cityvistion_mcp.server"],
      "env": { "CITYVISTION_API_KEY": "你的key" }
    }
  }
}

Cursor · Cline

Cursor:~/.cursor/mcp.json;Cline:cline_mcp_settings.json。内容同上 mcpServers JSON。

Cherry Studio

设置 → MCP 服务器 → 添加:类型 stdio,命令 python3,参数 -m cityvistion_mcp.server,环境变量 CITYVISTION_API_KEY=你的key。

B. MCP 托管端点(免安装)

端点 https://mcp.cgajs.com/mcp(streamable-http)。key 通过请求头传入:Authorization: Bearer <统一key>,或分服务头 x-cgajs-key / x-nl2cga-key / x-cityengine-key。

{
  "mcpServers": {
    "cityvistion": {
      "url": "https://mcp.cgajs.com/mcp",
      "headers": { "Authorization": "Bearer 你的key" }
    }
  }
}

C. Function-calling / REST

调用流程:把 tools 数组传给模型 → 模型返回 tool_calls → 按每项 x_endpoint 发 HTTP 请求并注入 x_auth 认证头 → 响应 JSON 以 role=tool 回传模型。

核心 REST 端点速查

能力端点认证
自然语言→CGAPOST www.nl2cga.com/api/v1/cga/generate(轮询 GET /api/v1/cga/jobs/{id})Bearer
CGA→GLB 编译POST www.cgajs.com/api/v1/compilex-api-key
官方引擎解析 CGA→模型POST api.cityengine.cn/v1/generate(轮询 GET /v1/jobs/{id})X-API-Key
一句话→模型(串联)POST api.cityengine.cn/v1/nl2modelX-API-Key
自然语言→CGA(同步)POST api.cityengine.cn/v1/nl2cgaX-API-Key
解析 CGA 可调属性POST www.cityengine.cn/api/v1/cv/inspect免 key
官方案例库GET www.cityengine.cn/home-demos.json免 key

典型链式用法

直接告诉你的 AI 助手:

「用 nl2cga_generate_cga 把『三层临街商铺,骑楼退界』生成 CGA,再用 cgajs_compile_cga 编译成模型,最后用 cityengine_parse_cga 出官方引擎对照版本。」

三服务天然串联:NL2CGA 出规则 → CGA.js 快速编译(×1 配额)→ CityEngine 官方引擎对齐验证。实测:Kimi Code CLI 全链调用 11 工具、18 官方案例、编译出 GLB 一次通过(2026-11-20)。