Skip to main content

CityEngine Cloud MCP Server & Tools

Text-to-3D city buildings in one sentence: natural language → CGA rules → cloud engine → glTF/glb — plus demo browsing and quota lookup. Read-only compute endpoints only.

This repository contains two complementary packages:

Package What it is Use it with
cityengine-mcp (repo root) MCP server (stdio, FastMCP) kimi code, Codex CLI, Claude Desktop, any MCP client
cityengine-tools/ OpenAI-compatible function-calling toolkit (schemas + client) DeepSeek, Qwen, GLM, GPT and any OpenAI-style tool-calling API

Live demos and self-service API keys: https://www.cityengine.cn/plugins.html · API contract: https://api.cityengine.cn

Tools (6)

Tool Description Quota
generate_cga Natural language → CGA rule source (sync, no rendering); supports base_cga + instruction refinement NL quota
parse_cga CGA source + attributes → engine parse → 3D model stats + glb download (sha256 verified) generate quota
generate_model Natural language → ready 3D model (NL2CGA + parse chained), returns cga_source too NL + generate
list_demos List showcase demos on the official site (id/name/engine/attribute count) free
get_demo Inspect a demo's attribute panel, node/material counts, engine timing free
get_quota Current key's plan and quota usage free

All endpoints are read-only compute calls — nothing writes to your account or the site.

Install (MCP server)

pip install cityengine-mcp        # or: pip install .  from this repo
# provides the `cityengine-mcp` console script; or run: python -m cityengine_mcp.server

Requirements: Python ≥ 3.10, mcp 1.x, httpx.

Get an API key

Keys use the cvk_ prefix. Two self-service ways:

  1. Website: register/log in at https://www.cityengine.cn → User Center → "插件 Key" → issue (shown once, save it).
  2. CLI:
curl -X POST https://api.cityengine.cn/v1/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"strong-password","nickname":"optional"}'
# the response api_key is your plugin key (shown in full only once)

Free tier: 5 NL generations/month, 100 model generations/day. Paid members: unlimited NL.

Configure your MCP client

Environment variables:

Variable Required Default Purpose
CITYENGINE_API_KEY yes — plugin API key (cvk_…)
CITYENGINE_GATEWAY_BASE no https://api.cityengine.cn gateway base URL
CITYENGINE_DEMOS_BASE no https://www.cityengine.cn demo listing site
CITYENGINE_OUTPUT_DIR no ./cityengine_mcp_output where glb files land
CITYENGINE_MAX_POLL_S no 300 render job poll cap (seconds)

Generic MCP client config:

{
  "mcpServers": {
    "cityengine": {
      "command": "python",
      "args": ["-m", "cityengine_mcp.server"],
      "env": { "CITYENGINE_API_KEY": "cvk_xxx" }
    }
  }
}

Ready-made snippets for kimi code, Codex CLI and Claude Desktop live in config-examples/.

OpenAI-compatible function calling (cityengine-tools/)

pip install ./cityengine-tools
from cityengine_tools import CityEngineTools
tools = CityEngineTools(api_key="cvk_xxx")
# pass tools.schemas() as the `tools` parameter of any OpenAI-compatible chat call;
# feed tool_calls back into tools.dispatch(...) to execute them.

JSON schemas for all six tools are in cityengine-tools/schemas/.

License

MIT (see LICENSE). The packages are client SDKs; generated models and CGA output are governed by your cityengine.cn plan terms.

Metadata

Release files for cityengine-mcp 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cityengine-mcp 0.1.0
File Size Uploaded Provenance Actions
cityengine_mcp-0.1.0.tar.gz 9.5 kB Without provenance Details for cityengine_mcp-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cityengine-mcp 0.1.0
File Interpreter ABI Platform Actions
cityengine_mcp-0.1.0-py3-none-any.whl Python 3 none any Details for cityengine_mcp-0.1.0-py3-none-any.whl

Total release size: 19.5 kB

Release files / cityengine_mcp-0.1.0.tar.gz

Download URL cityengine_mcp-0.1.0.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3ac07ba7ef4abce2ef566eb61816bb7b2f4f8e866dc2429db91c42d54a1cedb5
BLAKE2b-256 checksum
How to use checksums
b6d1617f40e13f8059a09b5d6644d45bc4778cabb10365980194ab68aeaeea14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Release files / cityengine_mcp-0.1.0-py3-none-any.whl

Download URL cityengine_mcp-0.1.0-py3-none-any.whl
Size 10.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9db715f7600a7cc6491631c514069a21bd261b9acb7a647014099e48fdcb4319
BLAKE2b-256 checksum
How to use checksums
386549a8882bae69c8c7d747bd200979aae8d8d7aaa5dd10001131acff7fea18
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.12

Security for cityengine-mcp 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page