Initial commit: Monarch MCP Custom SSE server
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Monarch Money Custom MCP Server
|
||||
|
||||
A custom Model Context Protocol (MCP) server for Monarch Money, designed for Docker deployment with SSE (Server-Sent Events) support.
|
||||
|
||||
## 🚀 Setup
|
||||
|
||||
### 1. Obtain Authentication Token
|
||||
Run the setup script locally to authenticate and generate a token:
|
||||
|
||||
```bash
|
||||
python login_setup.py
|
||||
```
|
||||
|
||||
Follow the prompts to log in. Once successful, copy the `MONARCH_TOKEN` printed in the terminal.
|
||||
|
||||
### 2. Configure Environment
|
||||
Create a `.env` file based on `.env.example` and paste your token:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
# Edit .env and set MONARCH_TOKEN=your_token_here
|
||||
```
|
||||
|
||||
### 3. Deploy with Docker
|
||||
Start the server using Docker Compose:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## 🔌 Connection
|
||||
The server will be available at:
|
||||
- **SSE Endpoint**: `http://localhost:8000/mcp/sse`
|
||||
- **Health Check**: `http://localhost:8000/health`
|
||||
|
||||
## 🛠️ Tools Included
|
||||
- `get_accounts`: View all financial accounts.
|
||||
- `get_transactions`: Fetch recent transactions with filtering.
|
||||
- `get_budgets`: View budget status.
|
||||
- `get_account_holdings`: Detailed investment holdings.
|
||||
- `refresh_accounts`: Trigger a refresh of account data.
|
||||
Reference in New Issue
Block a user