Skip to content

Commit

Permalink
Merge pull request #8 from basicmachines-co/claude-mcp-test
Browse files Browse the repository at this point in the history
docs: document MCP git and GitHub limitations
  • Loading branch information
phernandez authored Nov 27, 2024
2 parents ffab4ef + e6bcee5 commit 7387547
Show file tree
Hide file tree
Showing 4 changed files with 683 additions and 50 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/

.zed
77 changes: 27 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,27 @@
# Basic Factory

AI-assisted software development workflow tools.

## Overview

Basic Factory provides tools for integrating AI assistants (like Claude) into software development workflows via GitHub. It enables AI assistants to:

- Create and manage branches
- Commit changes
- Create pull requests
- Run and monitor GitHub Actions
- Participate in code review

## Github
For the GitHub token, you'll need to:

Go to GitHub Settings → Developer Settings → Personal Access Tokens
https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens


Create a new token with 'repo' scope
We can use this for both direct API calls and for GitHub Actions

## Installation

```bash
uv add basic-factory
```

## Development

Set up development environment:

```bash
# Create virtual environment
uv venv
uv sync

# Install project in editable mode with dev dependencies
uv add --dev --editable .
uv add --dev pytest pytest-cov ruff

source .venv/bin/activate

# Run tests
pytest
```


# MCP Filesystem Tools - Working Notes

## Tool Capabilities
1. **Directory Operations**
- `create_directory`: Creates new directories, including nested paths
- `list_directory`: Shows files and directories with [FILE] and [DIR] prefixes

2. **File Operations**
- `write_file`: Creates or overwrites files with content
- `read_file`: Retrieves file contents
- `move_file`: Relocates files between directories
- `get_file_info`: Provides metadata (size, dates, permissions)
- `search_files`: Finds files matching patterns (note: case sensitivity varies)

3. **Git Tool Limitations**
- Missing `git push` functionality
- Local operations only (add, commit, branch)
- No remote repository management
- Branch operations require extra verification

4. **GitHub Tool Limitations**
- No PR comment functionality
- No issue comments
- `push_files` requires existing remote branch
- PR creation returns merge_commit_sha errors
- Limited repository management options
- No direct comment or review features
Loading

0 comments on commit 7387547

Please sign in to comment.