Civil 3D MCP Server
Civil 3D MCP Server — динамический форк Roslyn
MCP-сервер, который позволяет ИИ-ассистентам писать и выполнять код на C# непосредственно внутри Autodesk Civil 3D. Вместо большого набора фиксированных инструментов ИИ генерирует код, специфичный для задачи, который выполняется с доступом к API Civil 3D.
Область проекта и происхождение
Этот форк сохраняет динамическую модель выполнения Roslyn/C# и намеренно небольшой публичный интерфейс из трёх MCP-инструментов. Его текущая базовая совместимость — Autodesk Civil 3D 2025, а локальная работа сосредоточена на надёжности, безопасности, измеримой эффективности и переиспользуемых навыках Civil 3D. Другие версии Civil 3D могут быть добавлены позже через отдельно проверенную работу по совместимости.
Проект происходит из barbosaihan/civil3d-mcp. SantosSjba/mcp-to-c3d был оценён на предмет отдельных идей, подкреплённых тестами, в то время как Sacred-G/Civil3D-mcp использовался только как архитектурный справочник. См. PROVENANCE.md для подробной атрибуции и границ лицензирования.
Этот независимый проект не аффилирован с Autodesk и не одобрен им. Сборки Autodesk и другие проприетарные файлы Civil 3D не включены.
Related MCP server: Civil 3D MCP Server
Архитектура
┌─────────────────┐ stdio ┌──────────────────┐ TCP/JSON-RPC ┌──────────────────┐
│ AI Assistant │ ◄────────────► │ MCP Server (TS) │ ◄──────────────────► │ Civil 3D Plugin │
│ (Claude, Cline) │ │ 3 meta-tools │ port 8080 │ Roslyn Engine │
└─────────────────┘ └──────────────────┘ └──────────────────┘
│ │
Skills Library C# Code Execution
(.skill.md files) (full Civil 3D API)3 мета-инструмента
Инструмент | Назначение | Безопасность |
| Выполнить код C# с доступом на запись; необязательное сохранение после фиксации | ⚠️ Изменяет чертёж |
| Выполнить код C# только для чтения (без фиксации) | ✅ Без побочных эффектов |
| Просмотр/поиск/чтение шаблонов кода навыков; | ✅ Только метаданные |
Как это работает
ИИ читает навык → Получает документированный шаблон кода на C#
ИИ адаптирует код → Заполняет параметры, комбинирует шаблоны
ИИ отправляет код → Через
civil3d_executeилиcivil3d_queryRoslyn компилирует и выполняет → Внутри Civil 3D с полным доступом к API
Результаты возвращаются в виде JSON → Обратно к ИИ
Пример взаимодействия
User: "What surfaces are in my drawing?"
AI: Uses civil3d_query with:
var surfaces = new List<object>();
foreach (ObjectId id in CivilDoc.GetSurfaceIds()) {
var s = Transaction.GetObject(id, OpenMode.ForRead) as TinSurface;
surfaces.Add(new { s.Name, s.Layer });
}
return surfaces;
Result: [{ "Name": "EG", "Layer": "C-TOPO-EG" }, ...]Библиотека навыков
civil3d_skills также поддерживает action: "api_lookup" для ограниченного поиска только для чтения по именам и сигнатурам публичных типов и членов из уже загруженных разрешённых сборок хоста Civil 3D. Он не загружает сборки, не выполняет код C# и не обращается к активному чертежу. Укажите запрос и, при необходимости, префикс сборки, пространства имён и ограничение количества результатов.
Навыки — это документированные шаблоны кода на C# в skills/:
skills/
├── surfaces/ # Surface operations
├── alignments/ # Alignment + station/offset
├── points/ # COGO points
├── geometry/ # Lines, polylines, text
├── drawing/ # Drawing info
└── workflows/ # Complex multi-object operationsГлобальные переменные скрипта
Код, выполняемый через civil3d_execute или civil3d_query, имеет доступ к:
Глобальная переменная | Тип | Описание |
|
| Активный документ AutoCAD |
|
| Активный документ Civil 3D |
|
| База данных документа |
|
| Активная транзакция |
|
| Редактор документа |
Все пространства имён Civil 3D автоматически импортируются.
Фиксация транзакции civil3d_execute изменяет открытый чертёж, но сама по себе не записывает файл DWG на диск. Установите saveDrawing: true, когда завершённое изменение также должно быть сохранено. Плагин сохраняет только после закрытия транзакции скрипта и блокировки документа; скрипты не должны сами вызывать Database.SaveAs или ставить в очередь QSAVE. Запрос на сохранение использует отдельный тайм-аут по умолчанию 10 минут и никогда не повторяется автоматически.
Настройка
1. Сборка MCP-сервера
npm install && npm run build2. Сборка плагина
# Copy DLLs from Civil 3D to C_References/ (see C_References/README.md)
cd plugin/Civil3dMcpPlugin
dotnet build3. Загрузка в Civil 3D
NETLOAD → select Civil3dMcpPlugin.dll
C3DMCPSTATUS → verify running4. Настройка ИИ
{
"mcpServers": {
"civil3d": {
"command": "node",
"args": ["/path/to/civil3d-mcp/build/index.js"]
}
}
}Переменные окружения
Переменная | По умолчанию | Описание |
|
| Хост плагина |
|
| Порт плагина |
|
| Тайм-аут выполнения (мс) |
|
| Тайм-аут для запросов выполнения с |
|
| Уровень журналирования |
Бенчмаркинг
Независимый от хоста рекордер фазы 2A, опциональный внутренний контракт live-трассировки фазы 2A.1 и раннер только для чтения фазы 2A.2 документированы в benchmark/README.md. Ни один из них не добавляет MCP-инструмент, очередь или повторные попытки; раннер 2A.2 может вызывать только свой фиксированный запрос только для чтения при явном запуске.
Структурированные ошибки (фаза 2B.1)
civil3d_query и civil3d_execute сохраняют существующее текстовое содержимое ошибок и isError: true, а также возвращают structuredContent со схемой civil3d-mcp-error/v1. Стабильные поля ошибки: code, category, message, source, outcome и retryable. Тайм-аут команды или потеря соединения после отправки имеют outcome: "unknown" и retryable: false; сервер никогда не повторяет их автоматически. Успешные ответы и публичный интерфейс из трёх инструментов не изменяются.
Приватный TCP-фрейминг (фаза 2C.1)
Каждое TCP-соединение localhost несёт один UTF-8 JSON-RPC запрос и один ответ. Каждое JSON-тело сопровождается LF и ограничено 8 МиБ, измеряемых в UTF-8 байтах без LF. Node-клиент по-прежнему принимает нефреймированный ответ предыдущего плагина, когда за полным JSON-телом следует упорядоченное закрытие соединения. Чрезмерно большие запросы отклоняются до их записи; чрезмерно большие или некорректные ответы и прерванные соединения порождают не повторяемые структурированные ошибки транспорта. Если выполнение завершилось, но плагин не смог вернуть чрезмерно большой результат, сообщается outcome: "unknown".
Аудит операций и идемпотентность записи (фазы 2I.1 / 2I.2)
При уровне журналирования info по умолчанию каждая принятая операция civil3d_query и civil3d_execute генерирует одно ограниченное событие аудита в stderr. Оно содержит новый непрозрачный идентификатор операции, имя инструмента, SHA-256 и длину в UTF-8 байтах исходного кода C#, статус успеха/ошибки и затраченные миллисекунды; ошибки добавляют только стабильные поля code/category/source/outcome. Событие аудита никогда не содержит код вызывающего, описание, идентичность чертежа, результат или сообщение об ошибке.
civil3d_execute также принимает необязательный непрозрачный idempotencyKey (1–128 ASCII букв, цифр, ., _, :, -). В одной сессии плагина он связывает ключ с UTF-8 C# SHA-256, нормализованной идентичностью expectedDrawing и выбором saveDrawing. Дубликат отклоняется как выполняющийся, конфликтующий или уже зафиксированный; зафиксированные записи не сохраняют результат, и вызывающий должен сверяться с запросом только для чтения. Сбой сохранения происходит после фиксации записи в памяти, поэтому его ключ сохраняется как завершённый, чтобы предотвратить случайное повторное изменение. Сессия хранит не более 256 завершённых ключей, детерминированно вытесняя самые старые. Это не добавляет ни постоянства, ни автоматических повторных попыток, ни семантики ровно один раз.
Безопасность
Песочница Roslyn блокирует:
Выполнение процессов (
Process.Start)Удаление файлов (
File.Delete)Сетевые запросы (
HttpClient,Sockets)Доступ к реестру
Динамическую загрузку сборок
Все операции API Civil 3D разрешены.
Эта regex-песочница — защита в глубину, а не граница доверия. Оба инструмента кода получают изменяемые объекты API Civil 3D и AutoCAD; civil3d_query пропускает фиксацию транзакции хоста, но не может гарантировать, что произвольный динамический C# не имеет побочных эффектов. Выполняйте только доверенный код, прошедший проверку. Loopback TCP предотвращает удалённый сетевой доступ, но не аутентифицирует другие локальные процессы.
Лицензия
MIT
Available Tools
3 toolscivil3d_executeA
Execute C# code in Civil 3D with write access. The code runs inside a committed transaction. Available globals: Document, CivilDoc, Database, Transaction, Editor. All Civil 3D namespaces are auto-imported. Return a value to get results back as JSON. Use this for operations that MODIFY the drawing (create, edit, delete objects). expectedDrawing must come from a prior read-only identity query. To persist the drawing file, set saveDrawing=true; do not call Database.SaveAs or queue QSAVE from the C# code.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | C# code to execute. Has access to Document, CivilDoc, Database, Transaction, Editor. Example: var id = TinSurface.Create(Database, "MySurface"); return new { success = true }; | |
| description | No | Optional human-readable summary; excluded from operation audit logs. | |
| saveDrawing | No | When true, save the currently named DWG after the write transaction commits and wait for completion. Use this instead of Database.SaveAs or Document.SendStringToExecute("QSAVE") in code. An unsaved drawing must first be named in Civil 3D. | |
| idempotencyKey | No | Optional opaque session key. Reuse it only to manually reconcile an uncertain outcome; use a new key for an intentional new write. | |
| expectedDrawing | Yes | Expected active drawing identity checked immediately before Civil API access. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and does well: it notes the committed transaction, available globals, JSON return, drawing identity check, and save workflow. It does not mention exception handling or failure rollback, but that is a minor gap for a code-execution tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, then elaborates on key parameters and constraints. It is not overly verbose, though bullet formatting could improve scannability; still, every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex code-execution tool with no output schema, the description explains available globals, return format, drawing identity requirements, save behavior, and sibling distinction. No critical operational detail is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, yet the description adds significant context: expectedDrawing provenance and check timing, saveDrawing conditions (must be named), idempotencyKey purpose, and an example for code. It clearly enhances schema-only information.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a precise purpose: executing C# code with write access in Civil 3D. It explicitly scopes the tool to modifying the drawing ('Use this for operations that MODIFY the drawing'), which distinguishes it from the read-only sibling civil3d_query.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides clear usage criteria: use for modifications, not for reads; requires expectedDrawing from a prior civil3d_query; and warns against calling Database.SaveAs or queuing QSAVE, directing the user to the saveDrawing parameter instead. This fully covers when and how to use it versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
civil3d_queryA
Execute C# code in Civil 3D in READ-ONLY mode (no changes saved). Available globals: Document, CivilDoc, Database, Transaction, Editor. All Civil 3D namespaces are auto-imported. Return a value to get results as JSON. Use this for querying data: listing objects, getting properties, analyzing surfaces, etc. Omit expectedDrawing only to bootstrap Database.Filename and Database.FingerprintGuid; otherwise supply it to guard the active drawing.
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | C# code to query data. Has access to Document, CivilDoc, Database, Transaction, Editor. Example: var surfaces = new List<object>(); foreach (ObjectId id in CivilDoc.GetSurfaceIds()) { var s = Transaction.GetObject(id, OpenMode.ForRead) as TinSurface; surfaces.Add(new { s.Name, s.Layer }); } return surfaces; | |
| expectedDrawing | No | Expected active drawing identity checked immediately before Civil API access. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and does substantial work: it discloses read-only semantics ('no changes saved'), available globals (Document, CivilDoc, Database, Transaction, Editor), auto-imported namespaces, the JSON return mechanism, and the expectedDrawing guard vs. bootstrap behavior. It does not cover error behavior for failed compilation or thrown exceptions at runtime, which is a notable gap for a code-execution tool, but the disclosed traits are rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: purpose/globals/return semantics, when-to-use, and the expectedDrawing rule. The first sentence is dense but not wasteful; the most critical differentiator (READ-ONLY) is front-loaded before supporting details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex code-execution tool with no annotations and no output schema, the description covers the essentials: execution mode, environment globals, namespaces, return format, and the identity-guard parameter semantics. The main omissions are error/exception behavior and the exact failure mode when expectedDrawing mismatches, which an agent invoking arbitrary C# code would benefit from knowing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds genuine value beyond the schema by explaining when to omit expectedDrawing entirely — 'Omit expectedDrawing only to bootstrap Database.Filename and Database.FingerprintGuid; otherwise supply it to guard the active drawing' — a semantic the schema's field descriptions do not convey.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Execute C# code in Civil 3D in READ-ONLY mode (no changes saved).' It further scopes the tool with 'Use this for querying data: listing objects, getting properties, analyzing surfaces, etc.', which clearly differentiates it from the sibling civil3d_execute. An agent can tell immediately what this tool does and how it differs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
'Use this for querying data' is an explicit when-to-use statement with concrete examples. The READ-ONLY framing implies that mutations belong to the sibling civil3d_execute, though it never names that alternative or states a when-not-to-use condition explicitly, so it stops short of a full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
civil3d_skillsA
Browse and read Civil 3D code skills (documented C# code templates). Use 'list' to see available skills, 'search' to find by keyword, 'get' to read the full skill with code template, or 'api_lookup' to search public metadata from already-loaded Civil 3D host assemblies. Skills are pre-built C# patterns you can adapt and execute via civil3d_execute or civil3d_query.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum list/search/api_lookup results to return (integer 1-50; default 20) | |
| query | No | Search query for 'search' or 'api_lookup' action | |
| action | Yes | list = browse skill metadata, search = find by keyword, get = read full skill, api_lookup = read-only public API metadata search | |
| cursor | No | Opaque nextCursor from a prior list/search call with the same filters | |
| assembly | No | Allowlisted loaded host assembly filter for api_lookup | |
| category | No | Filter by category (surfaces, alignments, points, etc.) | |
| namespace | No | Namespace prefix filter for api_lookup | |
| skillName | No | Skill name for 'get' action |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. It clearly labels the tool as read-only ('Browse and read', 'read-only public API metadata search'), implying no state changes. It also notes that execution happens via sibling tools, which further clarifies that this tool itself does not modify anything. The absence of side-effect warnings is acceptable given the read-only framing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences, each adding critical information: the core purpose, the list of actions, and the relationship to sibling tools. It front-loads the main purpose and avoids redundancy or filler. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only tool with four actions, the description is nearly complete. It explains the actions, implies the output (list of skills, search results, full skill content, API metadata), and points to the execution siblings. While it doesn't detail pagination or output structure, those are typically understood and the schema covers cursor details. The description is sufficient for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all eight parameters have descriptions in the schema. The tool description adds contextual meaning (e.g., what 'get' does, that api_lookup is read-only) but does not explain parameter syntax or constraints beyond the schema. This meets the baseline of 3 but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb-resource pair ('Browse and read Civil 3D code skills') and immediately enumerates the four supported actions (list, search, get, api_lookup). It also distinguishes itself from the sibling tools by noting that skills 'can be adapted and execute via civil3d_execute or civil3d_query.' This clearly sets its scope apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains the tool's role as a browsing/reading layer and explicitly points to the sibling tools for execution. It also differentiates between read actions (list/search/get) and the read-only metadata api_lookup. While it doesn't list explicit 'when not to use' scenarios, the purpose is clear enough for an agent to decide between this and its siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
3 tool updates
v1.0.0- First observed
civil3d_execute - First observed
civil3d_query - First observed
civil3d_skills
TDQS
Scored across 3 tools
Each tool has a clear, non-overlapping purpose: execute for write operations, query for read-only operations, and skills for browsing code templates. The read/write distinction is explicitly stated, so agents should not confuse execute and query.
All tools share the civil3d_ prefix and snake_case, but the suffixes mix verbs (execute, query) with a noun (skills), making it not a strictly consistent verb_noun pattern. The naming is still predictable and readable.
Three tools is a well-scoped set for a server that provides arbitrary C# execution capabilities; each tool serves a distinct and necessary function. The count falls within the typical 3-15 range.
The combination of execute and query covers the full range of Civil 3D operations (create, edit, delete, query), and skills fills the learning gap. No obvious missing functionality for the stated purpose.
Maintenance
Related MCP Connectors
- mcp-serverOAuthcom.make
Give your AI agents the tools to build, manage, and run automation workflows.
- SkilderOAuthai.skilder
One place to build, share, and govern the skills and tools your AI agents use at work.
- OolkinOAuthcom.oolkin
AI colleagues that keep your standards, your project and their reasoning between sessions
Image and video AI tools and your own pipelines, run from any AI assistant.
Related MCP Servers
- AlicenseAqualityDmaintenanceEnables AI assistants to interact with Autodesk Civil 3D, allowing them to retrieve project data, create/modify/delete drawing elements, and execute code to automate Civil 3D operations.336MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to write and execute C# code directly inside Autodesk Civil 3D, providing full API access through code generation and execution.102MIT
- AlicenseAqualityCmaintenanceEnables AI assistants to interact with Autodesk Civil 3D through natural language, supporting tools for surfaces, alignments, profiles, corridors, pipe networks, COGO points, and AutoCAD geometry.93MIT
- AlicenseNot gradedqualityAmaintenanceLets any MCP-compatible AI assistant read and edit Autodesk Civil 3D drawings through tools for alignments, surfaces, corridors, pipe networks, quantity takeoff, and cut/fill, using a local bridge plugin and named pipes.MIT