update readme
This commit is contained in:
parent
ca3174c10c
commit
7920585e68
1 changed files with 14 additions and 3 deletions
|
|
@ -1,9 +1,13 @@
|
||||||
# mcp-git
|
# mcp-git: A git MCP server
|
||||||
|
|
||||||
A Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.
|
A Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.
|
||||||
|
|
||||||
|
Please note that mcp-git is currently in early development. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.
|
||||||
|
|
||||||
## Available Tools
|
## Available Tools
|
||||||
|
|
||||||
|
The current list of tools includes:
|
||||||
|
|
||||||
- `git_read_file`: Read contents of a file at a specific Git reference
|
- `git_read_file`: Read contents of a file at a specific Git reference
|
||||||
- `git_list_files`: List all files in a repository or subdirectory
|
- `git_list_files`: List all files in a repository or subdirectory
|
||||||
- `git_file_history`: Get commit history for a specific file
|
- `git_file_history`: Get commit history for a specific file
|
||||||
|
|
@ -12,10 +16,15 @@ A Model Context Protocol server for Git repository interaction and automation. T
|
||||||
- `git_get_diff`: View diffs between Git references
|
- `git_get_diff`: View diffs between Git references
|
||||||
- `git_get_repo_structure`: View repository file structure
|
- `git_get_repo_structure`: View repository file structure
|
||||||
- `git_list_repos`: List available Git repositories
|
- `git_list_repos`: List available Git repositories
|
||||||
|
- `git_log`: Retrieve commit log for the repository
|
||||||
|
- `git_list_branches`: List all branches in the repository
|
||||||
|
- `git_list_tags`: List all tags in the repository
|
||||||
|
|
||||||
|
This list is expected to grow as we add more functionality to the server. We welcome contributions from the community to expand and enhance the available tools.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Using uv
|
### Using uv (recommended)
|
||||||
|
|
||||||
When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
|
When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
|
||||||
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-git*.
|
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-git*.
|
||||||
|
|
@ -91,7 +100,9 @@ Alternatively, if using pip installation:
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
We encourage contributions to help expand and improve mcp-git. Whether you want to add new tools, enhance existing functionality, or improve documentation, your input is valuable.
|
||||||
|
|
||||||
For examples of other MCP servers and implementation patterns, see:
|
For examples of other MCP servers and implementation patterns, see:
|
||||||
https://github.com/modelcontextprotocol/servers/
|
https://github.com/modelcontextprotocol/servers/
|
||||||
|
|
||||||
Pull requests welcome!
|
Pull requests are welcome! Feel free to contribute new ideas, bug fixes, or enhancements to make mcp-git even more powerful and useful.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue