Compare commits

...

3 Commits

Author SHA1 Message Date
smithery-ai[bot] 2493022e23 Update README 2025-03-11 19:12:40 +00:00
smithery-ai[bot] 8aec09ee0b Add Smithery configuration 2025-03-11 19:12:39 +00:00
smithery-ai[bot] 116619dfdb Add Dockerfile 2025-03-11 19:12:38 +00:00
3 changed files with 44 additions and 1 deletions
+16
View File
@@ -0,0 +1,16 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
FROM python:3.12-slim
WORKDIR /app
# Copy the project files
COPY . .
# Install pip and build dependencies
RUN pip install --upgrade pip \
&& pip install . --no-cache-dir --ignore-installed
# Expose port if necessary (e.g., uv might use a port, but MCP over stdio so not needed here)
# Use the basic-memory entrypoint to run the MCP server
CMD ["basic-memory", "mcp"]
+11 -1
View File
@@ -5,6 +5,7 @@
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![Tests](https://github.com/basicmachines-co/basic-memory/workflows/Tests/badge.svg)](https://github.com/basicmachines-co/basic-memory/actions)
[![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)
[![smithery badge](https://smithery.ai/badge/@basicmachines-co/basic-memory)](https://smithery.ai/server/@basicmachines-co/basic-memory)
Basic Memory lets you build persistent knowledge through natural conversations with Large Language Models (LLMs) like
Claude, while keeping everything in simple Markdown files on your computer. It uses the Model Context Protocol (MCP) to
@@ -21,6 +22,15 @@ incorporate human edits made directly to knowledge files.
## Quick Start
### Installing via Smithery
To install Basic Memory for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@basicmachines-co/basic-memory):
```bash
npx -y @smithery/cli install @basicmachines-co/basic-memory --client claude
```
### Installing Manually
```bash
# Install with uv (recommended)
uv install basic-memory
@@ -690,4 +700,4 @@ basic-memory tools write-note --title "Meeting Notes" --folder "meetings" < meet
AGPL-3.0
Built with ♥️ by Basic Machines
Built with ♥️ by Basic Machines
+17
View File
@@ -0,0 +1,17 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
properties: {}
description: No configuration required. This MCP server runs using the default command.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({
command: 'basic-memory',
args: ['mcp']
})
exampleConfig: {}