OUTPUT_FORMATS.md•3.32 kB
# Output Format Configuration
This document defines the output formats generated by each Summary MCP tool.
## Summary
| Tool Type | HTML | Markdown | JSON | Default |
|-----------|------|----------|------|---------|
| Daily Summary | ✅ | ✅ | ✅* | `both` |
| Weekly Summary | ✅ | ✅ | ✅* | `both` |
| Period Comparison | ✅ | ✅ | ❌ | `both` |
*JSON available but not generated by default
## Tool-by-Tool Breakdown
### 1. `generate_daily_summary`
**Default Behavior**: Generates both `.html` and `.md` files
**Available Options**:
- `output_format: 'both'` - Generates `.html` and `.md` (default)
- `output_format: 'html'` - Generates `.html` only
- `output_format: 'markdown'` - Generates `.md` only
- `output_format: 'json'` - Returns JSON object (no files)
**Example Files**:
```
daily-summary-2025-11-05.html
daily-summary-2025-11-05.md
```
**Usage**:
```
Generate my daily summary
# → Creates both .html and .md files
```
---
### 2. `generate_weekly_summary`
**Default Behavior**: Generates both `.html` and `.md` files
**Available Options**:
- `output_format: 'both'` - Generates `.html` and `.md` (default)
- `output_format: 'html'` - Generates `.html` only
- `output_format: 'markdown'` - Generates `.md` only
- `output_format: 'json'` - Returns JSON object (no files)
**Example Files**:
```
weekly-summary-2025-10-29-to-2025-11-05.html
weekly-summary-2025-10-29-to-2025-11-05.md
```
**Usage**:
```
Generate my weekly summary for the last 7 days
# → Creates both .html and .md files
```
---
### 3. `compare_periods`
**Default Behavior**: Generates both `.html` and `.md` files
**Available Options**:
- `output_format: 'both'` - Generates `.html` and `.md` (default)
- `output_format: 'html'` - Generates `.html` only
- `output_format: 'markdown'` - Generates `.md` only
- ⚠️ **NO JSON OPTION** - Comparisons are human-readable reports only
**Example Files**:
```
period-comparison-2025-10-22-vs-2025-10-29.html
period-comparison-2025-10-22-vs-2025-10-29.md
```
**Usage**:
```
Compare my productivity between last week and this week
# → Creates both .html and .md files
```
---
## Why These Defaults?
### Both formats by default
- **HTML**: Beautiful, shareable reports with styling
- **Markdown**: Editable, version-controllable text format
- Users get the best of both worlds without choosing
### No JSON for comparisons
- Comparisons are trend analysis reports
- Designed for human consumption, not programmatic access
- HTML and Markdown provide better visualization
- Keeps tool focused on its primary use case
### JSON available for summaries
- Daily/weekly summaries contain raw data
- Useful for building dashboards or custom tools
- Optional - not generated by default
---
## File Locations
All generated files are saved to:
```
~/shopify-projects/summary-mcp/summaries/
```
---
## Configuration Summary
```javascript
// Tool definitions
generate_daily_summary: {
output_format: {
default: 'both',
options: ['both', 'html', 'markdown', 'json']
}
}
generate_weekly_summary: {
output_format: {
default: 'both',
options: ['both', 'html', 'markdown', 'json']
}
}
compare_periods: {
output_format: {
default: 'both',
options: ['both', 'html', 'markdown'] // NO JSON
}
}
```
---
**Last Updated**: November 5, 2025