docs: add flexagent mcp installation instructions #3003
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Greptile Overview
Greptile Summary
This PR adds comprehensive installation instructions for the FlexAgent MCP server to the README, providing users with clear guidance on how to set up AI-assisted Tidy3D simulation capabilities across multiple MCP clients (Codex, Claude, Gemini, and Cursor). The documentation is well-structured with collapsible sections for each CLI/IDE combination and includes practical examples for both command-line and configuration-file approaches. Additionally, the license badge was improved to show the specific LGPL-2.1 license with a clickable link, and some extraneous whitespace was cleaned up.
Confidence Score: 5/5
Important Files Changed
File Analysis
Sequence Diagram
sequenceDiagram participant Dev as Developer participant README as README.md participant MCP as MCP Client participant TD3D as Tidy3D API Dev->>README: Read FlexAgent MCP section Note over Dev,README: Choose CLI client<br/>(Codex/Claude/Gemini/Cursor) Dev->>MCP: Run registration command<br/>(uvx tidy3d-mcp --api-key) Note over MCP: Register tidy3d-mcp server MCP->>TD3D: Connect with API key Note over MCP,TD3D: AI-assisted simulation<br/>capabilities enabled Dev->>MCP: Use FlexAgent features MCP->>TD3D: Execute Tidy3D operations