Skip to content

Commit bd139b2

Browse files
committed
Initial release of TextEdit MCP v1.0.0
A Model Context Protocol server for creating RTF documents in Claude Desktop Features: - Rich text formatting (bold, italic, strikethrough) - Text colors and highlighting (4 colors each) - Real RTF tables with full formatting support - Clickable hyperlinks - Bullet and numbered lists - Three document templates - Native macOS RTF generation Created by Pineapple 🍍
1 parent 67d2109 commit bd139b2

17 files changed

+919
-672
lines changed

.gitignore

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1-
.DS_Store
1+
# Swift
22
.build/
3-
*.xcodeproj
4-
Package.resolved
53
.swiftpm/
6-
DerivedData/
7-
*.xcuserstate
4+
Package.resolved
5+
*.xcodeproj
6+
7+
# macOS
8+
.DS_Store
9+
10+
# Development
11+
dev-tests/
12+
*.log
13+
*.tmp
14+
*.backup
15+
16+
# IDE
17+
.vscode/
18+
.idea/
19+
20+
# Build outputs
21+
*.rtf

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Changelog
2+
3+
All notable changes to TextEdit MCP will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-01-03
9+
10+
### Added
11+
- Initial release of TextEdit MCP
12+
- Rich text formatting (bold, italic, strikethrough)
13+
- Text colors (red, blue, green)
14+
- Highlighting in 4 colors (yellow, cyan, green, orange)
15+
- Real RTF tables with borders and cell formatting
16+
- Clickable hyperlinks
17+
- Bullet and numbered lists
18+
- Three document templates (Business, Technical, Meeting)
19+
- Markdown-like formatting syntax
20+
- Full macOS TextEdit compatibility
21+
- Claude Desktop MCP integration
22+
- Automatic installer script
23+
24+
### Technical Features
25+
- Built with Swift 5.9+ for macOS
26+
- Native NSAttributedString implementation
27+
- NSTextTable for proper RTF table generation
28+
- Model Context Protocol (MCP) server
29+
- Zero external dependencies
30+
- Comprehensive error handling and logging
31+
32+
---
33+
34+
Created by Pineapple 🍍

CONTRIBUTING.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Contributing to TextEdit MCP
2+
3+
Thank you for your interest in contributing to TextEdit MCP! This document provides guidelines and instructions for contributing.
4+
5+
## Code of Conduct
6+
7+
- Be respectful and inclusive
8+
- Welcome newcomers and help them get started
9+
- Focus on constructive criticism
10+
- Respect different viewpoints and experiences
11+
12+
## How to Contribute
13+
14+
### Reporting Bugs
15+
16+
1. Check if the bug has already been reported in [Issues](https://github.com/M-Pineapple/TextEdit-MCP/issues)
17+
2. Create a new issue with:
18+
- Clear title and description
19+
- Steps to reproduce
20+
- Expected vs actual behavior
21+
- System information (macOS version, Swift version)
22+
- Error logs if available
23+
24+
### Suggesting Features
25+
26+
1. Check existing issues for similar suggestions
27+
2. Create a new issue with the "enhancement" label
28+
3. Describe the feature and its use case
29+
4. Provide examples if possible
30+
31+
### Pull Requests
32+
33+
1. Fork the repository
34+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
35+
3. Make your changes
36+
4. Add tests if applicable
37+
5. Ensure all tests pass (`swift test`)
38+
6. Commit with clear messages
39+
7. Push to your fork
40+
8. Open a Pull Request
41+
42+
### Development Setup
43+
44+
```bash
45+
# Clone your fork
46+
git clone https://github.com/M-Pineapple/TextEdit-MCP.git
47+
cd TextEdit-MCP
48+
49+
# Build the project
50+
swift build
51+
52+
# Run tests
53+
swift test
54+
55+
# Build for release
56+
swift build -c release
57+
```
58+
59+
### Coding Standards
60+
61+
- Follow Swift naming conventions
62+
- Use meaningful variable and function names
63+
- Add comments for complex logic
64+
- Keep functions focused and small
65+
- Maintain compatibility with macOS 12.0+
66+
67+
### Testing
68+
69+
- Write tests for new features
70+
- Ensure existing tests pass
71+
- Test with Claude Desktop integration
72+
- Verify RTF output in TextEdit
73+
74+
### Documentation
75+
76+
- Update README.md for new features
77+
- Add examples to FORMATTING_GUIDE.md
78+
- Update CHANGELOG.md
79+
- Comment your code appropriately
80+
81+
## Project Structure
82+
83+
```
84+
Sources/TextEditMCP/
85+
├── main.swift # Entry point
86+
├── MCPServer.swift # MCP protocol implementation
87+
├── RTFDocumentService.swift # RTF generation logic
88+
└── MCPLogger.swift # Logging utilities
89+
```
90+
91+
## Key Areas for Contribution
92+
93+
- **New Formatting Features**: Additional text styles, colors, or layouts
94+
- **Template System**: More document templates
95+
- **Table Enhancements**: Cell merging, advanced styling
96+
- **Performance**: Optimization for large documents
97+
- **Error Handling**: Better error messages and recovery
98+
- **Cross-Platform**: Support for other platforms (Linux)
99+
100+
## Questions?
101+
102+
Feel free to open an issue for any questions about contributing!
103+
104+
---
105+
106+
Created by Pineapple 🍍

0 commit comments

Comments
 (0)