Metadata-Version: 2.3
Name: flow360-mcp
Version: 0.1.0rc1
Summary: Local stdio FastMCP proxy server for Flow360
Author: Flexcompute
License: Proprietary
Requires-Dist: fastmcp>=2.12.3
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# Flow360 MCP

Local MCP server for Flow360.

## Install

```bash
pip install flow360-mcp
```

```bash
uvx flow360-mcp
```

## Authentication

If you already use the [Flow360 Python client](https://github.com/flexcompute/Flow360), no extra authentication setup is required. The MCP server automatically picks up your existing credentials — just add the server config below and start using it.

If you haven't configured Flow360 yet, run:

```bash
pip install flow360
flow360 configure
```

This stores your API key locally and the MCP server will use it automatically.

Alternatively, you can pass the API key explicitly via the `SIMCLOUD_APIKEY` environment variable in the MCP config (see examples below).

## Configure MCP Hosts

### Claude Desktop

Add to your Claude Desktop MCP config:

```json
{
  "mcpServers": {
    "flow360": {
      "command": "uvx",
      "args": ["flow360-mcp"]
    }
  }
}
```

If you prefer to pass the API key explicitly instead of relying on the Flow360 config, add an `env` block:

```json
{
  "mcpServers": {
    "flow360": {
      "command": "uvx",
      "args": ["flow360-mcp"],
      "env": {
        "SIMCLOUD_APIKEY": "YOUR_SIMCLOUD_API_KEY"
      }
    }
  }
}
```

### VS Code / Cursor

Add the same server entry to your MCP config file (for example `.vscode/mcp.json` or `.cursor/mcp.json`):

```json
{
  "mcpServers": {
    "flow360": {
      "command": "uvx",
      "args": ["flow360-mcp"]
    }
  }
}
```

## CLI and Configuration

- `--api-key`: SimCloud API key (highest priority).
- `SIMCLOUD_APIKEY`: API key fallback when `--api-key` is not set.
- `~/.flow360/config.toml`: Default Flow360 fallback via `[default].apikey`.
- `REMOTE_MCP_URL`: Optional MCP endpoint override.
- `FLOW360_MCP_USER_AGENT`: Optional User-Agent override.
- `TIDY3D_MCP_USER_AGENT`: Secondary User-Agent fallback.

## Troubleshooting

- `API key required...`: pass `--api-key`, set `SIMCLOUD_APIKEY`, or configure `[default].apikey` in `~/.flow360/config.toml`.
- Auth failure: confirm the API key is valid.
- Connection failure: verify `REMOTE_MCP_URL` and network access.
