diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-mcp.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-mcp.mdx index 98765c662..047b7ae95 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-mcp.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-mcp.mdx @@ -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 `** + + The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`. + - **`--dashboard-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=`). 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=`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`. - **`--api-key `** diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx index 361f5f952..d76dc7187 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-logs.mdx @@ -43,11 +43,11 @@ The following options are available: - **`--apphost `** - The path to the Aspire AppHost project file. + The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`. - **`--dashboard-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=`). 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=`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`. - **`--api-key `** @@ -123,6 +123,12 @@ The following options are available: aspire otel logs --dashboard-url "http://localhost:18888/login?t=" ``` +- View logs from a secured standalone Aspire Dashboard: + + ```bash title="Aspire CLI" + aspire otel logs --dashboard-url "http://localhost:18888" --api-key "" + ``` + ## See also - [aspire otel command](../aspire-otel/) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx index 9c1b92fe0..32307d5ce 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-spans.mdx @@ -43,11 +43,11 @@ The following options are available: - **`--apphost `** - The path to the Aspire AppHost project file. + The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`. - **`--dashboard-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=`). 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=`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`. - **`--api-key `** @@ -123,6 +123,12 @@ The following options are available: aspire otel spans --dashboard-url "http://localhost:18888/login?t=" ``` +- View spans from a secured standalone Aspire Dashboard: + + ```bash title="Aspire CLI" + aspire otel spans --dashboard-url "http://localhost:18888" --api-key "" + ``` + ## See also - [aspire otel command](../aspire-otel/) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx index c41f27ac1..0d07d052e 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-otel-traces.mdx @@ -45,11 +45,11 @@ The following options are available: - **`--apphost `** - The path to the Aspire AppHost project file. + The path to the Aspire AppHost project file. Mutually exclusive with `--dashboard-url`. - **`--dashboard-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=`). 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=`). When a login URL is provided, the token is automatically exchanged for an API key. Mutually exclusive with `--apphost`. - **`--api-key `** @@ -121,6 +121,12 @@ The following options are available: aspire otel traces --dashboard-url "http://localhost:18888/login?t=" ``` +- View traces from a secured standalone Aspire Dashboard: + + ```bash title="Aspire CLI" + aspire otel traces --dashboard-url "http://localhost:18888" --api-key "" + ``` + ## See also - [aspire otel command](../aspire-otel/)