Skip to content

Commit 0a1fdd8

Browse files
committed
update docs
Signed-off-by: phernandez <paul@basicmachines.co>
1 parent dfaf0fe commit 0a1fdd8

4 files changed

Lines changed: 59 additions & 28 deletions

File tree

CLAUDE.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ See the [README.md](README.md) file for a project overview.
3737
- API uses FastAPI for endpoints
3838
- Follow the repository pattern for data access
3939
- Tools communicate to api routers via the httpx ASGI client (in process)
40+
- avoid using "private" functions in modules or classes (prepended with _)
4041

4142
### Codebase Architecture
4243

@@ -134,30 +135,32 @@ could achieve independently.
134135

135136
## GitHub Integration
136137

137-
Basic Memory has taken AI-Human collaboration to the next level by integrating Claude directly into the development workflow through GitHub:
138+
Basic Memory uses Claude directly into the development workflow through GitHub:
138139

139140
### GitHub MCP Tools
140141

141-
Using the GitHub Model Context Protocol server, Claude can now:
142+
Using the GitHub Model Context Protocol server, Claude can:
142143

143144
- **Repository Management**:
144-
- View repository files and structure
145-
- Read file contents
146-
- Create new branches
147-
- Create and update files
145+
- View repository files and structure
146+
- Read file contents
147+
- Create new branches
148+
- Create and update files
148149

149150
- **Issue Management**:
150-
- Create new issues
151-
- Comment on existing issues
152-
- Close and update issues
153-
- Search across issues
151+
- Create new issues
152+
- Comment on existing issues
153+
- Close and update issues
154+
- Search across issues
154155

155156
- **Pull Request Workflow**:
156-
- Create pull requests
157-
- Review code changes
158-
- Add comments to PRs
157+
- Create pull requests
158+
- Review code changes
159+
- Add comments to PRs
159160

160-
This integration enables Claude to participate as a full team member in the development process, not just as a code generation tool. Claude's GitHub account ([bm-claudeai](https://github.com/bm-claudeai)) is a member of the Basic Machines organization with direct contributor access to the codebase.
161+
This integration enables Claude to participate as a full team member in the development process, not just as a code
162+
generation tool. Claude's GitHub account ([bm-claudeai](https://github.com/bm-claudeai)) is a member of the Basic
163+
Machines organization with direct contributor access to the codebase.
161164

162165
### Collaborative Development Process
163166

@@ -168,4 +171,5 @@ With GitHub integration, the development workflow includes:
168171
3. **Branch management** - Claude can create feature branches for implementations
169172
4. **Documentation maintenance** - Claude can keep documentation updated as the code evolves
170173

171-
This level of integration represents a new paradigm in AI-human collaboration, where the AI assistant becomes a full-fledged team member rather than just a tool for generating code snippets.
174+
With this integration, the AI assistant is a full-fledged team member rather than just a tool for generating code
175+
snippets.

docs/CLI Reference.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,10 +241,12 @@ You can redirect input from a file:
241241
basic-memory tool write-note --title "Meeting Notes" --folder "meetings" < meeting_notes.md
242242
```
243243

244-
#### Integration with Claude Code
244+
## Integration with Claude Code
245245

246246
This feature works well with Claude Code in the terminal:
247247

248+
### cli
249+
248250
In a Claude Code session, let Claude know he can use the basic-memory tools, then he can execute them via the cli:
249251

250252
```
@@ -257,6 +259,32 @@ In a Claude Code session, let Claude know he can use the basic-memory tools, the
257259
258260
```
259261

262+
### MCP
263+
264+
Claude code can also now use mcp tools, so it can use any of the basic-memory tool natively. To install basic-memory in Claude Code:
265+
266+
Run
267+
```
268+
claude mcp add basic-memory basic-memory mcp
269+
```
270+
271+
For example:
272+
273+
```
274+
➜ ~ claude mcp add basic-memory basic-memory mcp
275+
Added stdio MCP server basic-memory with command: basic-memory mcp to project config
276+
➜ ~ claude mcp list
277+
basic-memory: basic-memory mcp
278+
```
279+
280+
You can then use the `/mcp` command in the REPL:
281+
282+
```
283+
/mcp
284+
⎿ MCP Server Status
285+
286+
• basic-memory: connected
287+
```
260288

261289
## Troubleshooting Common Issues
262290

32.8 KB
Loading

uv.lock

Lines changed: 11 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)