mirror of
https://github.com/jorenn92/Maintainerr.git
synced 2026-06-01 18:48:13 +02:00
Document Codex MCP config and media integration coverage (#2974)
This commit is contained in:
committed by
GitHub
parent
d0d5d40ace
commit
45b90c4efa
@@ -0,0 +1,7 @@
|
||||
[mcp_servers.github]
|
||||
url = "https://api.githubcopilot.com/mcp/"
|
||||
http_headers = { "X-MCP-Readonly" = "true" }
|
||||
|
||||
[mcp_servers.playwright]
|
||||
command = "npx"
|
||||
args = ["@playwright/mcp@latest", "--headless", "--isolated", "--output-dir", ".playwright-mcp"]
|
||||
@@ -16,7 +16,7 @@ yarn test | tail -20
|
||||
|
||||
## Project Overview
|
||||
|
||||
Maintainerr is a media management application that helps users automatically manage their media libraries by creating rules to handle unused or unwatched content. It integrates with Plex, \*arr applications (Radarr/Sonarr), Overseerr/Jellyseerr, and Tautulli to provide comprehensive media lifecycle management.
|
||||
Maintainerr is a media management application that helps users automatically manage their media libraries by creating rules to handle unused or unwatched content. It integrates with Plex, Jellyfin, Emby, \*arr applications (Radarr/Sonarr), Overseerr/Jellyseerr, Tautulli, and Streamystats (Jellyfin only) to provide comprehensive media lifecycle management.
|
||||
|
||||
For the broader system architecture map, see [ARCHITECTURE.md](ARCHITECTURE.md).
|
||||
|
||||
@@ -111,6 +111,14 @@ yarn turbo test
|
||||
The development Docker workflow builds the multi-stage `Dockerfile` for
|
||||
`linux/amd64` and `linux/arm64`.
|
||||
|
||||
### Workspace MCP Servers
|
||||
|
||||
Project MCP server config lives in `.codex/config.toml` for Codex, `.mcp.json`
|
||||
for Claude Code, and `.vscode/mcp.json` for VS Code. Keep all three files in
|
||||
sync when adding or changing servers. The configured GitHub MCP server is
|
||||
read-only, and Playwright MCP screenshots should be written under
|
||||
`.playwright-mcp/`.
|
||||
|
||||
### Package-Specific Commands
|
||||
|
||||
```bash
|
||||
@@ -230,9 +238,11 @@ When modifying existing code, follow these specific refactoring priorities:
|
||||
The application integrates with several external services:
|
||||
|
||||
- **Plex**: Media server API for collections and metadata
|
||||
- **Jellyfin/Emby**: Media server APIs through the shared media-server abstraction
|
||||
- **Radarr/Sonarr**: Movie/TV show management APIs
|
||||
- **Overseerr/Jellyseerr**: Request management systems
|
||||
- **Tautulli**: Plex analytics and statistics
|
||||
- **Streamystats**: Jellyfin item-level analytics surfaced on media details
|
||||
|
||||
When working with these integrations:
|
||||
|
||||
|
||||
@@ -25,6 +25,9 @@ Maintainerr/
|
||||
|-- docs/ # Feature-level technical notes
|
||||
|-- docker/ # Docker helper configuration
|
||||
|-- tools/ # Release and maintenance scripts
|
||||
|-- .codex/config.toml # Codex project MCP server config
|
||||
|-- .mcp.json # Claude Code project MCP server config
|
||||
|-- .vscode/mcp.json # VS Code MCP server config mirror
|
||||
|-- Dockerfile # Multi-stage production image
|
||||
|-- README.md # Product overview and installation entry point
|
||||
|-- CONTRIBUTING.md # Contributor setup and process
|
||||
@@ -218,6 +221,9 @@ Testing conventions:
|
||||
`apps/server/src`.
|
||||
- UI tests use Vitest and React Testing Library.
|
||||
- Contracts use TypeScript checks and package-level linting.
|
||||
- Project MCP server config lives in `.codex/config.toml`, `.mcp.json`, and
|
||||
`.vscode/mcp.json`; keep them in sync. The GitHub MCP server is read-only,
|
||||
and Playwright screenshots should be saved under `.playwright-mcp/`.
|
||||
|
||||
See `CONTRIBUTING.md` for setup, branching, and pull request expectations.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user