Open-source Revit MCP server: let Claude and other AI assistants read and edit BIM models, with human approval on every change.
Python aecai-agentsautodeskautomationbimclaudeifcmcpmcp-servermodel-context-protocolnavisworksrevitrevit-addinrevit-apirhino
Fix README links and documentation references
A. Sam Mohammad02266d79224c
diff --git a/README.md b/README.mdindex 43347e8..345b6c6 100644--- a/README.md+++ b/README.md@@ -214,7 +214,7 @@ Package all supported versions:- [Installation](docs/install.md)- [Tool reference](docs/tools.md)- [Architecture](docs/architecture.md)-- [Configuration](docs/configuration-reference.md)+- [Configuration reference](docs/configuration-reference.md)- [Build and install scripts](docs/build-and-install-scripts.md)- [Target frameworks and dependencies](docs/target-frameworks-and-dependencies.md)- [MCP marketplaces](docs/marketplaces.md)diff --git a/docs/configuration-reference.md b/docs/configuration-reference.mdnew file mode 100644index 0000000..54d91c4--- /dev/null+++ b/docs/configuration-reference.md@@ -0,0 +1,55 @@+# Configuration Reference++This page documents the main environment variables, package metadata, and runtime settings used by the Revit MCP bridge.++## Runtime Modes++The server supports two runtime modes:++- `mock`: uses the built-in mock bridge for CI, development, and tests.+- `bridge`: connects to the Revit add-in over HTTP on `127.0.0.1:3000`.++## Environment Variables++| Variable | Required | Default | Description |+|---|---:|---|---|+| `MCP_REVIT_MODE` | Yes | `mock` | Selects the active bridge mode. |+| `MCP_REVIT_BRIDGE_URL` | Bridge mode | `http://127.0.0.1:3000` | URL of the Revit bridge listener. |+| `MCP_REVIT_ALLOWED_DIRECTORIES` | Yes in production | current workspace | Semicolon-separated directories the server may access. |+| `WORKSPACE_DIR` | Yes for file operations | current workspace | Root directory for generated files and workspace-backed tools. |+| `MCP_REVIT_AUDIT_LOG` | No | `workspace/audit.jsonl` | Audit log path used by the security layer. |+| `REVIT_SDK` | Build only | unset | Optional path used by the add-in build scripts. |++## Package and Registry Metadata++The Python package and MCP registry metadata are defined in:++- `packages/mcp-server-revit/pyproject.toml`+- `packages/mcp-server-revit/manifest.json`+- `server.json`++The current package name is `aec-model-bridge`, and the official repository URL is:++- https://github.com/Sam-AEC/aec-model-bridge++## MCP Client Example++```json+{+ "mcpServers": {+ "revit": {+ "command": "python",+ "args": ["-m", "revit_mcp_server.mcp_server"],+ "env": {+ "MCP_REVIT_MODE": "bridge",+ "MCP_REVIT_BRIDGE_URL": "http://127.0.0.1:3000"+ }+ }+ }+}+```++## Notes++- The server should be run from the repository root or an environment where the package is installed in editable mode.+- For Revit integration, make sure the Revit add-in is installed and Revit is running before testing the bridge endpoint.diff --git a/docs/install.md b/docs/install.mdindex ac7b2fd..2868d2b 100644--- a/docs/install.md+++ b/docs/install.md@@ -23,8 +23,8 @@ Mock mode runs the complete MCP server with deterministic responses, suitable fo### 1. Clone Repository```bash-git clone https://github.com/YOUR_ORG/mcp-revit-bridge.git-cd mcp-revit-bridge+git clone https://github.com/Sam-AEC/aec-model-bridge.git+cd aec-model-bridge```### 2. Create Virtual Environment@@ -148,14 +148,20 @@ $env:MCP_REVIT_MODE = "bridge"$env:MCP_REVIT_BRIDGE_URL = "http://localhost:3000"```-Or edit [examples/revit-mcp-config.json](../examples/revit-mcp-config.json):+Or use the workspace MCP configuration in [.vscode/mcp.json](../.vscode/mcp.json) for VS Code and GitHub Copilot, and set the same environment variables in your shell for other clients:```json{- "mode": "bridge",- "bridge_url": "http://localhost:3000",- "workspace_dir": "C:\\revit-workspace",- "allowed_directories": ["C:\\revit-workspace"]+ "servers": {+ "revit": {+ "command": "python",+ "args": ["-m", "revit_mcp_server.mcp_server"],+ "env": {+ "MCP_REVIT_MODE": "bridge",+ "MCP_REVIT_BRIDGE_URL": "http://127.0.0.1:3000"+ }+ }+ }}```