diff --git a/README.md b/README.md index 3a0ba8164..0d12da900 100644 --- a/README.md +++ b/README.md @@ -262,6 +262,43 @@ Examples of relations: - documented_in [[Coffee Journal]] ``` +## Using with VS Code +For one-click installation, click one of the install buttons below... + +[![Install with UV in VS Code](https://img.shields.io/badge/VS_Code-UV-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=basic-memory&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22basic-memory%22%2C%22mcp%22%5D%7D) [![Install with UV in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-UV-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=basic-memory&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22basic-memory%22%2C%22mcp%22%5D%7D&quality=insiders) + +You can use Basic Memory with VS Code to easily retrieve and store information while coding. Click the installation buttons above for one-click setup, or follow the manual installation instructions below. + +### Manual Installation + +Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`. + +```json +{ + "mcp": { + "servers": { + "basic-memory": { + "command": "uvx", + "args": ["basic-memory", "mcp"] + } + } + } +} +``` + +Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others. + +```json +{ + "servers": { + "basic-memory": { + "command": "uvx", + "args": ["basic-memory", "mcp"] + } + } +} +``` + ## Using with Claude Desktop Basic Memory is built using the MCP (Model Context Protocol) and works with the Claude desktop app (https://claude.ai/):