diff --git a/README.md b/README.md index 8d9a84e..3436973 100644 --- a/README.md +++ b/README.md @@ -508,9 +508,22 @@ GitHub Release cannot publish twice. ## Documentation and support +Canonical service documentation lives at [xmemo.dev/docs](https://xmemo.dev/docs/quickstart). +This repository documents the client; the pages below document the hosted service +it connects to. + +| | | +| --- | --- | +| **Quickstart** | [xmemo.dev/docs/quickstart](https://xmemo.dev/docs/quickstart) | +| **MCP overview and per-client setup** | [xmemo.dev/docs/mcp/overview](https://xmemo.dev/docs/mcp/overview) | +| **Tool reference** (`remember`, `recall`, `search`, …) | [xmemo.dev/docs/tools/remember](https://xmemo.dev/docs/tools/remember) | +| **REST API** | [xmemo.dev/docs/api/authentication](https://xmemo.dev/docs/api/authentication) | +| **Troubleshooting** | [xmemo.dev/docs/troubleshooting](https://xmemo.dev/docs/troubleshooting) | +| **Machine-readable index** | [xmemo.dev/llms.txt](https://xmemo.dev/llms.txt) | + - [XMemo](https://xmemo.dev) -- [XMemo MCP guide](https://xmemo.dev/product/mcp) - [MCP server reference](./MCP-README.md) +- [Adding a new client](./ADDING_CLIENTS.md) - [Issues](https://github.com/yonro/memory-os-cli/issues) - [Releases](https://github.com/yonro/memory-os-cli/releases) diff --git a/context7.json b/context7.json new file mode 100644 index 0000000..b1a26f3 --- /dev/null +++ b/context7.json @@ -0,0 +1,41 @@ +{ + "$schema": "https://context7.com/schema/context7.json", + "projectTitle": "XMemo CLI", + "description": "Official CLI and MCP setup helper for XMemo (@xmemo/client). Connects editors, CLIs, and autonomous agents to a private memory layer while keeping credentials out of project files.", + "branch": "main", + "folders": [], + "excludeFolders": [ + "test", + "tests", + ".github", + "scripts", + "dist", + "node_modules", + ".worktrees", + ".progress", + ".tmp-mcp-test", + "docs/assets" + ], + "excludeFiles": [ + "package-lock.json", + "glama.json" + ], + "rules": [ + "Use https://xmemo.dev/mcp as the canonical hosted XMemo MCP endpoint.", + "Install the CLI as the npm package @xmemo/client; the primary command is `xmemo`.", + "Use the authentication mode documented for the specific MCP client; prefer OAuth only where that client profile explicitly supports it.", + "Never hardcode XMEMO_KEY, bearer tokens, API keys, passwords, or other credentials in public configuration, source code, or generated client config files.", + "For token-based clients, read XMEMO_KEY from an environment variable or supported secret store.", + "Treat X-Memory-OS-Agent-ID and XMEMO_AGENT_INSTANCE_ID as attribution identifiers, not authentication credentials.", + "Keep XMEMO_AGENT_INSTANCE_ID stable for the same local installation or autonomous runner; generate a different value for a different local agent profile.", + "Prefer `xmemo mcp add --write` over hand-editing a client config file, so the stable instance identity is generated correctly.", + "`xmemo setup` is dry-run by default; configuration is only written when --write or --yes is passed.", + "Use `xmemo doctor` and `xmemo status` to diagnose a connection before changing configuration.", + "`xmemo uninstall` removes only XMemo-owned entries and marker-scoped behavior profiles; unrelated MCP servers, credentials, and device identity are left intact.", + "Use only XMemo commands, flags, tools, SDK helpers, parameters, scopes, and endpoints that are explicitly documented. Never invent XMemo APIs, tool names, or CLI flags.", + "Store durable and reusable context in XMemo, such as project facts, decisions, preferences, corrections, and handoff information; avoid transient conversation noise.", + "Preserve documented project, memory scope, provenance, and attribution semantics when saving or retrieving context.", + "Prefer the current canonical XMemo developer documentation at https://xmemo.dev/docs/quickstart over old examples, marketing pages, third-party snippets, or deprecated configuration.", + "This repository is the public client. The XMemo service repository is private; do not link readers to github.com/yunze7373/memory-os, which is not publicly reachable." + ] +} diff --git a/plugins/kiro/POWER.md b/plugins/kiro/POWER.md index 378b17e..84d4b52 100644 --- a/plugins/kiro/POWER.md +++ b/plugins/kiro/POWER.md @@ -142,7 +142,7 @@ To remove XMemo from Kiro, manually edit `~/.kiro/settings/mcp.json` and remove - All memory content is user-owned and controlled through your XMemo account ## License and support -This power is licensed under [LicenseRef-Proprietary](file:///h:/repos/memory-os-cli/plugins/kiro/LICENSE). +This power is licensed under [LicenseRef-Proprietary](./LICENSE). This power integrates with XMemo MCP Server (LicenseRef-Proprietary). -- [Privacy Policy](https://xmemo.dev/privacy) +- [Privacy Policy](https://xmemo.dev/legal/privacy) - [Support](mailto:support@xmemo.dev)