feat: initial project structure
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# mcp-synology-filestation
|
||||
|
||||
MCP server for Synology FileStation — browse, search, transfer, and manage files
|
||||
on your NAS via Claude.
|
||||
|
||||
## Status
|
||||
|
||||
Work in progress. See [SPEC.md](SPEC.md) for the planned tool set.
|
||||
|
||||
## Planned Tools
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `list_shares` | List all shared folders |
|
||||
| `list_dir` | Directory contents with pagination and sorting |
|
||||
| `get_info` | File or folder metadata |
|
||||
| `search` | Recursive pattern search |
|
||||
| `download` | Download a file (base64 content) |
|
||||
| `create_folder` | Create a new directory |
|
||||
| `rename` | Rename a file or folder |
|
||||
| `move` | Move to a new location |
|
||||
| `copy` | Copy to a new location |
|
||||
| `delete` | Delete a path (requires confirmation) |
|
||||
| `upload` | Upload a file from base64 content |
|
||||
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
uv tool install git+https://gitea.gecheckt.de/marcus/mcp-synology-filestation.git
|
||||
mcp-synology-filestation setup
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
uv sync --dev
|
||||
uv run pytest
|
||||
uv run ruff check src/
|
||||
uv run ruff format src/
|
||||
```
|
||||
Reference in New Issue
Block a user