Skip to content

docs(mcp): document memwal_login + memwal_logout tools (ENG-1749)#151

Merged
ducnmm merged 1 commit into
devfrom
feat/mcp-server-sidecar
May 14, 2026
Merged

docs(mcp): document memwal_login + memwal_logout tools (ENG-1749)#151
ducnmm merged 1 commit into
devfrom
feat/mcp-server-sidecar

Conversation

@harrymove-ctrl

Copy link
Copy Markdown
Collaborator

Summary

Brings docs/mcp/overview.md in line with the inline-login flow shipped in 1b296b1 (ENG-1749). The previous text told users to run npx ... login from a separate terminal and restart their MCP client — the same friction PR #141 review flagged as a blocker. After ENG-1749, the stdio package advertises memwal_login and memwal_logout tools, so the agent signs in inline without leaving the chat.

Changes

  • Tools section: split into 4 memory tools + 2 session tools (6 total).
  • Streamable HTTP setup: keeps the CLI as the way to mint a bearer token; reframed so it's no longer the only path.
  • stdio setup: leads with the inline memwal_login flow; CLI is now a fallback. Documents the 5-minute URL window and the memwal_logout path for account switching.
  • New "CLI Flags and Environment Variables" section: covers --logout, --label, --web-url, --login, --help, and MEMWAL_MCP_DEBUG.
  • Environment presets: now also lists the dashboard URL alongside the relayer.
  • Self-hosting: inlines the MCP session-cap env vars (SIDECAR_URL, MCP_MAX_TOTAL_SESSIONS, MCP_MAX_SESSIONS_PER_IP, MCP_MAX_NEW_SESSIONS_PER_IP_PER_MIN) instead of punting entirely to the env-vars reference.
  • packages/mcp/README.md: one-line nudge so the package README also points users at the inline-login tool.

ENG-1750 (native OAuth for HTTP transport) is still in progress and is intentionally not documented here.

Test plan

  • Render docs/mcp/overview.md in the Mintlify preview and verify tables, callouts, and code fences look correct.
  • Spot-check internal links: /reference/environment-variables.
  • Sanity-check the npm README on the next package publish (packages/mcp/README.md shows the new intro line).

Bring the MCP overview in line with the inline-login flow shipped in
1b296b1. Previously the docs told users to run `npx ... login` from a
separate terminal and restart their MCP client. After ENG-1749 the
stdio package advertises memwal_login and memwal_logout tools, so the
agent can sign in or switch accounts without leaving the chat.

Changes:
- Tools section: split into 4 memory tools + 2 session tools (6 total)
- Streamable HTTP setup: keep the CLI as the way to mint a bearer token
- stdio setup: lead with the inline memwal_login flow; CLI is now a
  fallback. Note the 5-minute URL window and the memwal_logout path
- New "CLI Flags and Environment Variables" section covering --logout,
  --label, --web-url, --login, --help, and MEMWAL_MCP_DEBUG
- Environment presets: surface the dashboard URL alongside the relayer
- Self-hosting: inline the key MCP session-cap env vars instead of
  punting entirely to the env-vars reference

packages/mcp/README.md gets a one-line nudge so the package README also
points users at the inline-login tool rather than implying a manual CLI
step.
@ducnmm ducnmm merged commit 729378e into dev May 14, 2026
8 checks passed
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.

3 participants