Skip to content

[docs] Add --dashboard-url and --api-key options to aspire agent mcp and aspire otel command docs #817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IEvangelist merged 1 commit into from
May 5, 2026
Merged

[docs] Add --dashboard-url and --api-key options to aspire agent mcp and aspire otel command docs #817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-agent-mcp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,19 @@ When the server is running, MCP-compatible clients can connect to it to:
- Execute resource commands (start, stop, restart)
- Query integration information

You can also run the MCP server in dashboard-only mode by providing `--dashboard-url`. In this mode, only telemetry tools (structured logs, traces) are available — resource management tools that require an AppHost are not registered.
You can also connect directly to a standalone Aspire Dashboard (one not managed by an AppHost) by providing `--dashboard-url`. In this dashboard-only mode, only the three telemetry tools (`list_structured_logs`, `list_traces`, `list_trace_structured_logs`) are exposed; AppHost-specific tools are not available.

## Options

The following options are available:

- **`--apphost <apphost>`**

The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`.

- **`--dashboard-url <url>`**

The URL of a standalone Aspire Dashboard to connect to instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key. When this option is specified, the server runs in dashboard-only mode with only telemetry tools available.
The URL of a standalone Aspire Dashboard to connect to instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`.

- **`--api-key <key>`**

Expand Down
10 changes: 8 additions & 2 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ The following options are available:

- **`--apphost <apphost>`**

The path to the Aspire AppHost project file.
The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`.

- **`--dashboard-url <url>`**

The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key.
The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`.

- **`--api-key <key>`**

Expand Down Expand Up @@ -123,6 +123,12 @@ The following options are available:
aspire otel logs --dashboard-url "http://localhost:18888/login?t=<token>"
```

- View logs from a secured standalone Aspire Dashboard:

```bash title="Aspire CLI"
aspire otel logs --dashboard-url "http://localhost:18888" --api-key "<your-api-key>"
```

## See also

- [aspire otel command](../aspire-otel/)
Expand Down
10 changes: 8 additions & 2 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ The following options are available:

- **`--apphost <apphost>`**

The path to the Aspire AppHost project file.
The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`.

- **`--dashboard-url <url>`**

The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key.
The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`.

- **`--api-key <key>`**

Expand Down Expand Up @@ -123,6 +123,12 @@ The following options are available:
aspire otel spans --dashboard-url "http://localhost:18888/login?t=<token>"
```

- View spans from a secured standalone Aspire Dashboard:

```bash title="Aspire CLI"
aspire otel spans --dashboard-url "http://localhost:18888" --api-key "<your-api-key>"
```

## See also

- [aspire otel command](../aspire-otel/)
Expand Down
10 changes: 8 additions & 2 deletions src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ The following options are available:

- **`--apphost <apphost>`**

The path to the Aspire AppHost project file.
The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`.

- **`--dashboard-url <url>`**

The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key.
The URL of a standalone Aspire Dashboard to query instead of discovering one from an AppHost. Accepts a base URL (for example, `http://localhost:18888`) or a full login URL including a browser token (for example, `http://localhost:18888/login?t=<token>`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`.

- **`--api-key <key>`**

Expand Down Expand Up @@ -121,6 +121,12 @@ The following options are available:
aspire otel traces --dashboard-url "http://localhost:18888/login?t=<token>"
```

- View traces from a secured standalone Aspire Dashboard:

```bash title="Aspire CLI"
aspire otel traces --dashboard-url "http://localhost:18888" --api-key "<your-api-key>"
```

## See also

- [aspire otel command](../aspire-otel/)
Expand Down
Loading