Skip to content

Commit 32b8d4f

Browse files
anandgupta42claude
andauthored
docs: update for v0.2.3–v0.2.4 changes (#51)
- Security FAQ: document well-known URL auth confirmation prompt and command validation (from #45) - Troubleshooting: add MCP server initialization failure section — init errors are now logged instead of silently swallowed (from #45) - Telemetry: document flush retry and flush-before-exit behavior (from #45, #46) - Getting started: mention postinstall welcome banner and upgrade changelog display (from #48) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d51ff20 commit 32b8d4f

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed

docs/docs/configure/telemetry.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ We collect the following categories of events:
3636

3737
Each event includes a timestamp, anonymous session ID, and the CLI version.
3838

39+
## Delivery & Reliability
40+
41+
Telemetry events are buffered in memory and flushed periodically. If a flush fails (e.g., due to a transient network error), events are re-added to the buffer for one retry. On process exit, the CLI performs a final flush to avoid losing events from the current session.
42+
43+
No events are ever written to disk — if the process is killed before the final flush, buffered events are lost. This is by design to minimize on-disk footprint.
44+
3945
## Why We Collect Telemetry
4046

4147
Telemetry helps us:

docs/docs/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Unlike general-purpose coding agents, altimate is built for data teams:
2020
npm install -g @altimateai/altimate-code
2121
```
2222

23+
After install, you'll see a welcome banner with quick-start commands. On upgrades, the banner also shows what changed since your previous version.
24+
2325
## First run
2426

2527
```bash

docs/docs/security-faq.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,21 @@ Or via environment variable:
126126
export ALTIMATE_TELEMETRY_DISABLED=true
127127
```
128128

129+
## What happens when I authenticate via a well-known URL?
130+
131+
When you run `altimate auth login <url>`, the CLI fetches `<url>/.well-known/altimate-code` to discover the server's auth command. Before executing anything:
132+
133+
1. **Validation** — The auth command must be an array of strings. Malformed or unexpected types are rejected.
134+
2. **Confirmation prompt** — You are shown the exact command and must explicitly approve it before it runs.
135+
136+
```
137+
$ altimate auth login https://mcp.example.com
138+
◆ The server requests to run: gcloud auth print-access-token. Allow?
139+
│ ● Yes / ○ No
140+
```
141+
142+
This prevents a malicious server from silently executing arbitrary commands on your machine.
143+
129144
## Are MCP servers a security risk?
130145

131146
MCP (Model Context Protocol) servers extend Altimate Code with additional tools. They run as local subprocesses or connect via SSE/HTTP. Security considerations:

docs/docs/troubleshooting.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,23 @@ altimate --print-logs --log-level DEBUG
6262
4. For Snowflake: ensure the warehouse is not suspended
6363
5. For BigQuery: check that the service account has the required IAM roles
6464

65+
### MCP Server Initialization Failures
66+
67+
**Symptoms:** MCP tools missing or MCP server not available after startup.
68+
69+
**Solutions:**
70+
71+
1. Check the log files — MCP initialization errors are now logged with the server name and error message:
72+
```
73+
WARN failed to initialize MCP server { key: "my-tools", error: "..." }
74+
```
75+
2. Verify the MCP server command is correct in your config
76+
3. Test the server manually:
77+
```bash
78+
altimate mcp test my-tools
79+
```
80+
4. Check that required environment variables are set (e.g., API keys referenced in the MCP config)
81+
6582
### LSP Server Won't Start
6683

6784
**Symptoms:** No diagnostics or completions for a language.

0 commit comments

Comments
 (0)