Skip to content

docs: fix drift in Configuration Tools - #324

Closed
jack-arturo wants to merge 1 commit into
mainfrom
docs/audit-cli-config-tools-20260824
Closed

docs: fix drift in Configuration Tools#324
jack-arturo wants to merge 1 commit into
mainfrom
docs/audit-cli-config-tools-20260824

Conversation

@jack-arturo

Copy link
Copy Markdown
Member

Automated docs-accuracy audit of /docs/cli/config-tools. Both copy-pasteable config snippets and the recall example on this page were broken as written.

Supersedes stale #282 (opened 2026-08-04, never merged).

Claim Current state Fix Evidence
JSON snippet: "mcpServers": { "automem": { ..., "args": ["@verygoodplugins/mcp-automem"] } } buildClaudeDesktopSnippet() and buildMcpConfigJson() both emit the key memory; the Claude Desktop builder passes ["-y", "@verygoodplugins/mcp-automem"]. A user pasting this registers a differently-named server, so the documented mcp__memory__* tool names never appear. Key → memory, args → ["-y", ...] mcp-automem@0cd7498:src/cli/templates.ts#L5-L21, #L58-L70
Codex TOML snippet: [[mcp_servers]] array-of-tables with name = "automem" and a [mcp_servers.env] block The shipped template uses a named table — [mcp_servers.memory] with args = ["-y", ...] and [mcp_servers.memory.env]. The documented name = key is not part of the Codex schema, so the snippet does not register a server. Rewrote to the shipped shape mcp-automem@0cd7498:templates/codex/config.toml#L7-L19
npx @verygoodplugins/mcp-automem recall "project architecture" The recall branch parses --query, --tags, and --limit and ignores positional arguments — query stays '', so the documented command recalls against an empty query. recall --query "project architecture", plus one line naming the three flags mcp-automem@0cd7498:src/index.ts#L381-L395
"Debug output includes: configuration values loaded (API key is masked) / each tool call with parameters / HTTP request/response details / retry attempts and backoff timing" — and, under Troubleshooting, that AUTOMEM_LOG_LEVEL=debug on a recall "shows the resolved endpoint and whether an apiKey was found" AUTOMEM_LOG_LEVEL is read in exactly two places, both in server mode: L94 gates a process.title line, L488 gates AutoMem MCP server running. No tool-call, HTTP, retry, or config logging exists behind the flag, and the recall CLI branch never reads it. Replaced both claims with what the flag actually does; pointed the troubleshooting step at config and at the recall JSON output instead mcp-automem@0cd7498:src/index.ts#L94, #L488
Env-resolution diagram: endpoint is a bare AUTOMEM_API_URL exists? check, key priority is a two-tier list resolveAutoMemApiUrl() walks three candidates (AUTOMEM_API_URLCLAUDE_PLUGIN_OPTION_API_URLAUTOMEM_ENDPOINT) before defaulting; readAutoMemApiKeyFromEnv() walks four. The diagram contradicted the page's own prose 30 lines above, which already lists the four key tiers. Diagram now names resolveAutoMemApiUrl() and both full priority chains mcp-automem@0cd7498:src/env.ts#L12-L25, #L35-L52

Verified against: verygoodplugins/mcp-automem@0cd7498

Questions

  • The environment-variable table is missing AUTOMEM_PARENT_WATCHDOG_MS (read in src/index.ts via parseWatchdogIntervalMs, documented in the repo's AGENTS.md with a 30000 default) and the four CLAUDE_PLUGIN_OPTION_* names that the prose below the table already describes. Adding rows is an editorial call about what this table is meant to enumerate — client-facing knobs only, or every variable the process reads — so I left it alone rather than guess.
  • AUTOMEM_API_URL is marked Required: Yes in the table, but resolveAutoMemApiUrl() falls back to http://127.0.0.1:8001 and the server only warns (and only on an interactive TTY). "Required" may be deliberate advice rather than a description of the code; not changed.

Unverified

  • None. Every claim checked on this page resolved to code in mcp-automem.

Follow-ups

  • Platform Installers table lists four commands (cursor, claude-code, codex, openclaw). Three more ship and are routed in src/index.ts: copilot (L327), hermes (L347), grok (L352). grok in particular writes AUTOMEM_PROCESS_TAG: 'grok:memory' into its generated config (src/cli/grok-config.ts#L57), which is the only shipped consumer of a variable this page documents as user-set.
  • Configuration File Locations table has no rows for Hermes (~/.hermes/config.yaml, per buildHermesSnippet()), Copilot, or Grok.
  • Content Size Governance cites soft 500 / hard 2000 as store_memory tool behavior; those are MEMORY_CONTENT_SOFT_LIMIT / MEMORY_CONTENT_HARD_LIMIT on the service side (automem), not enforced by the MCP client. Worth re-attributing on a future pass.

Generated by Claude Code

Verified against mcp-automem@0cd7498.

- JSON snippet registered the server as "automem" without -y; every shipped
  builder uses the "memory" key with args ["-y", ...].
- Codex TOML snippet used a [[mcp_servers]] array-of-tables with name =
  "automem"; the shipped template is [mcp_servers.memory] with -y.
- recall parses --query/--tags/--limit only, so the documented positional
  form ran an empty query.
- AUTOMEM_LOG_LEVEL=debug gates two stderr lines, not tool-call, HTTP or
  retry logging; both places claiming otherwise are corrected.
- Env-resolution diagram now matches resolveAutoMemApiUrl() and
  readAutoMemApiKeyFromEnv(), including the CLAUDE_PLUGIN_OPTION_* tiers.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019x1F51zpGqkBSDz6XGQgmr
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying automem-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: cb2c8e4
Status: ✅  Deploy successful!
Preview URL: https://5e4cd0dc.automem-website.pages.dev
Branch Preview URL: https://docs-audit-cli-config-tools-znbb.automem-website.pages.dev

View logs

@jack-arturo

Copy link
Copy Markdown
Member Author

Superseded by merged #354. This fresh replacement was rebuilt from current main against mcp-automem 0.16.0@9a0bbf754dd31db524da25638b0e97907e32ff37, then corrected through independent review with focused tests, full tests, build, and deployment checks.

@jack-arturo

Copy link
Copy Markdown
Member Author

Closing now that every release-validated claim is carried by merged replacement #354. The legacy branch is preserved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants