Skip to content

workflows.md

Latest commit

 

History

History
109 lines (82 loc) · 3 KB

workflows.md

File metadata and controls

109 lines (82 loc) · 3 KB
Raw

MCP Workflow Patterns

Practical patterns for AI agents using RevitDevTool MCP tools.

Workflow: Code Execution (Create/Read/Update/Delete)

flowchart LR
    A[search_dynamic resources] --> B[invoke_dynamic read cheatsheet/context]
    B --> C[Optional: prompts/get revit_code]
    C --> D[invoke_dynamic tool execute_csharp_code]
    D -->|Success| E[Verify result]
    D -->|Compilation Error| C
    D -->|Runtime Error / Rollback| F[Read warnings → fix → retry]
Loading

Key Points

  • Discover host targets with search_dynamic (includes machineId + hostInstanceId)
  • Read resources via invoke_dynamic with kind=resource (or resource_template)
  • Execute with invoke_dynamic kind=tool target=execute_csharp_code
  • Error responses are categorized: [COMPILATION ERROR], [RUNTIME ERROR], [ROLLBACK]

Workflow: Vision (Verify Visual Results)

flowchart LR
    A[Execute code changes] --> B[invoke_dynamic tool view_screenshot]
    B --> C{AI inspects image}
    C -->|Looks correct| D[Done]
    C -->|Issues found| E[Undo + retry]
Loading

Workflow: Undo (Recover from Mistakes)

flowchart LR
    A[Execute code] --> B{Result OK?}
    B -->|Yes| C[Continue]
    B -->|No| D[invoke_dynamic navigate_history]
    D --> E[Verify model state]
    E --> F[Retry with corrected code]
Loading

Key Points

  • navigate_history: direction="back"|"forward", steps=N
  • Always pass hostInstanceId when multiple hosts are connected

Workflow: Full Development Loop

flowchart TD
    Start[Task received] --> Search[search_dynamic for tools/resources]
    Search --> Read[invoke_dynamic read cheatsheet + context + version]
    Read --> Plan[Plan implementation]
    Plan --> Code[Generate and execute via invoke_dynamic]
    Code --> Check{Success?}
    Check -->|Error| Fix[Read error details → fix → retry]
    Fix --> Code
    Check -->|Success| Verify[invoke_dynamic view_screenshot]
    Verify --> Visual{Looks right?}
    Visual -->|No| Undo[navigate_history back]
    Undo --> Code
    Visual -->|Yes| Done[Report success]
Loading

Token Efficiency Tips

  1. search_dynamic is local — repeated searches do not open host pipes
  2. Read cheatsheet once per session — cache it, don't re-read every call
  3. Read model context before each operation — live and cheap
  4. Do not expect external tool list changes — ConnectedHostCatalog refreshes internally only
  5. Structured errors save retries — read the error category before regenerating code

Multi-Instance Scenarios

{
  "name": "invoke_dynamic",
  "arguments": {
    "capabilityId": "<from search_dynamic>",
    "hostInstanceId": 12345,
    "arguments": { "code": "..." }
  }
}

Use list_host_instances or search_dynamic to discover PIDs and capability IDs.

Related

  • In-host dispatch: docs/architecture/Execution/mcp-dispatch.md
  • Daemon architecture: docs/architecture/MCP/daemon.md
  • Transport modes: docs/architecture/MCP/transport.md