Skip to content

Commit eb1e7b6

Browse files
authored
feat: Add Smithery integration for easier installation (#24)
This PR adds support for deploying Basic Memory on the Smithery platform. Signed-off-by: bm-claudeai <claude@basicmachines.co>
1 parent 9203730 commit eb1e7b6

3 files changed

Lines changed: 45 additions & 1 deletion

File tree

Dockerfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
2+
FROM python:3.12-slim
3+
4+
WORKDIR /app
5+
6+
# Copy the project files
7+
COPY . .
8+
9+
# Install pip and build dependencies
10+
RUN pip install --upgrade pip \
11+
&& pip install . --no-cache-dir --ignore-installed
12+
13+
# Expose port if necessary (e.g., uv might use a port, but MCP over stdio so not needed here)
14+
15+
# Use the basic-memory entrypoint to run the MCP server
16+
CMD ["basic-memory", "mcp"]

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
66
[![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
77
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
8+
[![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
89

910
Basic Memory lets you build persistent knowledge through natural conversations with Large Language Models (LLMs) like
1011
Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
@@ -47,7 +48,19 @@ uv install basic-memory
4748

4849
You can view shared context via files in `~/basic-memory` (default directory location).
4950

50-
You can also install the cli tools to sync files or manage projects.
51+
### Alternative Installation via Smithery
52+
53+
You can use [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory) to automatically configure Basic Memory for Claude Desktop:
54+
55+
```bash
56+
npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude
57+
```
58+
59+
This installs and configures Basic Memory without requiring manual edits to the Claude Desktop configuration file. The Smithery server hosts the MCP server component, while your data remains stored locally as Markdown files.
60+
61+
### CLI Tools
62+
63+
You can also install the CLI tools to sync files or manage projects.
5164

5265
```bash
5366
uv tool install basic-memory

smithery.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
2+
3+
startCommand:
4+
type: stdio
5+
configSchema:
6+
# JSON Schema defining the configuration options for the MCP.
7+
type: object
8+
properties: {}
9+
description: No configuration required. This MCP server runs using the default command.
10+
commandFunction: |-
11+
(config) => ({
12+
command: 'basic-memory',
13+
args: ['mcp']
14+
})
15+
exampleConfig: {}

0 commit comments

Comments
 (0)