Skip to content

Commit 523418d

Browse files
committed
docs: add flexagent mcp installation instructions
1 parent d160d0f commit 523418d

File tree

1 file changed

+64
-2
lines changed

1 file changed

+64
-2
lines changed

README.md

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Name](https://img.shields.io/badge/pypi-tidy3d-blue?style=for-the-badge)](https:
44
[![PyPI version shields.io](https://img.shields.io/pypi/v/tidy3d.svg?style=for-the-badge)](https://pypi.python.org/pypi/tidy3d/)
55
[![Documentation Status](https://readthedocs.com/projects/flexcompute-tidy3ddocumentation/badge/?version=latest&style=for-the-badge)](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)
66
[![Tests](https://img.shields.io/github/actions/workflow/status/flexcompute/tidy3d/tidy3d-python-client-tests.yml?branch=develop&style=for-the-badge)](https://github.com/flexcompute/tidy3d/actions/workflows/tidy3d-python-client-tests.yml)
7-
![License](https://img.shields.io/github/license/flexcompute/tidy3d?style=for-the-badge)
7+
[![License: LGPL-2.1](https://img.shields.io/badge/license-LGPL--2.1-blue?style=for-the-badge)](LICENSE)
88
[![Ruff](https://img.shields.io/badge/code%20style-ruff-5A4FCF?style=for-the-badge)](https://github.com/astral-sh/ruff)
99
![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/daquinteroflex/4702549574741e87deaadba436218ebd/raw/tidy3d_extension.json)
1010

@@ -20,7 +20,6 @@ This repository contains the python API to allow you to:
2020
* Submit and manage simulations running on Flexcompute's servers.
2121
* Download and postprocess the results from the simulations.
2222

23-
2423
![](https://raw.githubusercontent.com/flexcompute/tidy3d/main/img/snippet.png)
2524

2625
## Installation
@@ -74,6 +73,69 @@ To get started, our documentation has a lot of [examples](https://docs.flexcompu
7473
| FAQ | https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/index.html |
7574

7675

76+
## FlexAgent MCP
77+
78+
FlexAgent adds an AI-assisted layer on top of Tidy3D via the Model Context Protocol (MCP); read more about [AI-assisted simulation in Tidy3D](https://hs.flexcompute.com/news/ai-assisted-simulation-in-tidy3d-ushering-in-a-new-era-of-photonic-design). Install the `tidy3d-mcp` server when you want that experience inside an MCP client without the Tidy3D extension for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Cursor](https://open-vsx.org/extension/Flexcompute/tidy3d).
79+
80+
These commands assume [uv](https://docs.astral.sh/uv/getting-started/installation/) is installed on your machine.
81+
82+
**Register the server with your MCP client** - use the block below that matches your CLI.
83+
84+
<details>
85+
<summary>Codex CLI / IDE</summary>
86+
87+
```bash
88+
codex mcp add tidy3d -- uvx tidy3d-mcp --api-key "YOUR_TIDY3D_API_KEY"
89+
```
90+
91+
</details>
92+
93+
<details>
94+
<summary>Claude CLI / Desktop / Code</summary>
95+
96+
```bash
97+
claude mcp add tidy3d -- uvx tidy3d-mcp --api-key "YOUR_TIDY3D_API_KEY"
98+
```
99+
100+
</details>
101+
102+
<details>
103+
<summary>Gemini CLI</summary>
104+
105+
Create or edit `.gemini/settings.json` (project) or `~/.gemini/settings.json` (global):
106+
107+
```json
108+
{
109+
"mcpServers": {
110+
"tidy3d": {
111+
"command": "uvx",
112+
"args": ["tidy3d-mcp", "--api-key", "YOUR_TIDY3D_API_KEY"]
113+
}
114+
}
115+
}
116+
```
117+
118+
</details>
119+
120+
<details>
121+
<summary>Cursor CLI / IDE</summary>
122+
123+
Cursor reuses the same schema across the editor and `cursor-agent`. Configure `.cursor/mcp.json` (per-project) or `~/.cursor/mcp.json` (global) and then run `cursor-agent mcp list` to verify:
124+
125+
```json
126+
{
127+
"mcpServers": {
128+
"tidy3d": {
129+
"command": "uvx",
130+
"args": ["tidy3d-mcp", "--api-key", "YOUR_TIDY3D_API_KEY"]
131+
}
132+
}
133+
}
134+
```
135+
136+
</details>
137+
138+
77139
## Related Source Repositories
78140

79141
| Name | Repository |

0 commit comments

Comments
 (0)