mcp-ynab/README.md

Model Context Protocol server for YNAB integration

# MCP YNAB Server

A Model Context Protocol (MCP) server for integrating with You Need A Budget (YNAB) API.

## Description

This MCP server provides a bridge between AI assistants and the YNAB budgeting application, allowing for seamless budget management and financial data access through conversational interfaces.

## Features

- **Tools**: Placeholder tools for YNAB operations (to be implemented)
- **Resources**: Access to YNAB budget data (to be implemented)
- **Prompts**: Budget-related prompt templates (to be implemented)

## Installation

1. Clone this repository:
   ```bash
   git clone https://github.com/richdooz/mcp-ynab.git
   cd mcp-ynab
   ```

2. Install dependencies:
   ```bash
   npm install
   ```

3. Set up environment variables:
   ```bash
   cp .env.example .env
   # Edit .env with your YNAB API key and other configuration
   ```

## Configuration

Create a `.env` file based on `.env.example` and configure the following:

- `YNAB_API_KEY`: Your YNAB Personal Access Token
- `YNAB_BUDGET_ID`: (Optional) Specific budget ID to target
- Other configuration options as needed

## Usage

### Development

```bash
npm run dev
```

### Production

```bash
npm start
```

### As an MCP Server

This server is designed to be used with MCP-compatible clients. Configure your MCP client to use this server:

```json
{
  "mcpServers": {
    "ynab": {
      "command": "node",
      "args": ["path/to/mcp-ynab/src/index.js"]
    }
  }
}
```

## Development

This is currently a placeholder implementation. The following areas need development:

### Tools to Implement
- Budget retrieval
- Account management
- Transaction operations
- Category management
- Goal tracking

### Resources to Implement
- Budget summaries
- Account balances
- Transaction histories
- Category spending reports

### Prompts to Implement
- Budget analysis prompts
- Spending advice templates
- Financial goal setting

## API Reference

### Tools

Currently includes placeholder tools. Real YNAB integration tools will be added.

### Resources

Currently includes placeholder resources. Real YNAB data resources will be added.

### Prompts

Currently includes placeholder prompts. Real budget-related prompts will be added.

## Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

## License

MIT License - see LICENSE file for details

## Requirements

- Node.js >= 18.0.0
- YNAB Personal Access Token
- MCP-compatible client

## Support

For issues and questions, please use the GitHub issue tracker.