Skip to content

Commit da6be33

Browse files
committed
Add config examples for Claude Desktop, setting flag
1 parent 6d91eb2 commit da6be33

File tree

2 files changed

+124
-7
lines changed

2 files changed

+124
-7
lines changed

QUICKSTART.md

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,23 @@ This guide will help you get the MCP OmniFocus server running with Claude Deskto
1010

1111
## Installation
1212

13-
### 1. Build the Server
13+
You can install the MCP OmniFocus server either via Homebrew or by building from source.
14+
15+
### Option A: Install via Homebrew (Recommended)
16+
17+
```bash
18+
# Add the tap (if not already added)
19+
brew tap conall/mcp-omnifocus
20+
21+
# Install the server
22+
brew install mcp-omnifocus
23+
```
24+
25+
This installs:
26+
- The `mcp-omnifocus` binary to `/opt/homebrew/bin/` (Apple Silicon) or `/usr/local/bin/` (Intel)
27+
- The JXA scripts to `/opt/homebrew/share/mcp-omnifocus/scripts/` (Apple Silicon) or `/usr/local/share/mcp-omnifocus/scripts/` (Intel)
28+
29+
### Option B: Build from Source
1430

1531
```bash
1632
# Clone or navigate to the repository
@@ -25,14 +41,42 @@ make build
2541

2642
This creates the executable at `bin/mcp-omnifocus`.
2743

28-
### 2. Configure Claude Desktop
44+
## Configuration
45+
46+
### 1. Configure Claude Desktop
2947

3048
1. Open your Claude Desktop configuration file:
3149
```bash
3250
open ~/Library/Application\ Support/Claude/claude_desktop_config.json
3351
```
3452

35-
2. Add the OmniFocus MCP server to your configuration:
53+
2. Add the OmniFocus MCP server to your configuration based on how you installed it:
54+
55+
**For Homebrew Installation (Apple Silicon):**
56+
```json
57+
{
58+
"mcpServers": {
59+
"omnifocus": {
60+
"command": "/opt/homebrew/bin/mcp-omnifocus",
61+
"args": ["-scripts", "/opt/homebrew/share/mcp-omnifocus/scripts"]
62+
}
63+
}
64+
}
65+
```
66+
67+
**For Homebrew Installation (Intel Mac):**
68+
```json
69+
{
70+
"mcpServers": {
71+
"omnifocus": {
72+
"command": "/usr/local/bin/mcp-omnifocus",
73+
"args": ["-scripts", "/usr/local/share/mcp-omnifocus/scripts"]
74+
}
75+
}
76+
}
77+
```
78+
79+
**For Source Build:**
3680
```json
3781
{
3882
"mcpServers": {
@@ -44,7 +88,7 @@ This creates the executable at `bin/mcp-omnifocus`.
4488
}
4589
```
4690

47-
**Important**: Replace `/absolute/path/to/mcp-omnifocus` with the actual absolute path to your repository. For example:
91+
Replace `/absolute/path/to/mcp-omnifocus` with the actual path to your repository. For example:
4892
```json
4993
{
5094
"mcpServers": {
@@ -56,19 +100,19 @@ This creates the executable at `bin/mcp-omnifocus`.
56100
}
57101
```
58102

59-
**Note**: The `-scripts` argument is optional. If omitted, the server will auto-detect the scripts directory, but specifying it explicitly is more reliable.
103+
**Note**: The `-scripts` argument explicitly tells the server where to find the JXA automation scripts. While the server can auto-detect the scripts directory in many cases, specifying it explicitly ensures reliability across different installation methods.
60104

61105
3. Save the file and restart Claude Desktop.
62106

63-
### 3. Grant Permissions
107+
### 2. Grant Permissions
64108

65109
On first use, macOS will prompt you to grant automation permissions:
66110

67111
1. Open **System Preferences****Security & Privacy****Privacy****Automation**
68112
2. Grant `osascript` permission to control OmniFocus
69113
3. You may also need to grant Terminal or Claude Desktop permission
70114

71-
### 4. Test the Server
115+
### 3. Test the Server
72116

73117
Open Claude Desktop and try these example commands:
74118

RELEASE.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,79 @@ After the workflow completes:
6565
3. Download and test one of the archives
6666
4. Verify checksums.txt is present
6767

68+
## Installation and Usage
69+
70+
### Installing via Homebrew
71+
72+
Users can install the server via Homebrew:
73+
74+
```bash
75+
brew tap conall/mcp-omnifocus
76+
brew install mcp-omnifocus
77+
```
78+
79+
This installs:
80+
- Binary: `/opt/homebrew/bin/mcp-omnifocus` (Apple Silicon) or `/usr/local/bin/mcp-omnifocus` (Intel)
81+
- Scripts: `/opt/homebrew/share/mcp-omnifocus/scripts/` (Apple Silicon) or `/usr/local/share/mcp-omnifocus/scripts/` (Intel)
82+
83+
### Installing from Release Archive
84+
85+
Users can also download the release archive and extract it:
86+
87+
```bash
88+
# Download the appropriate archive for your architecture
89+
curl -LO https://github.com/conall/mcp-omnifocus/releases/download/v0.1.0/mcp-omnifocus_0.1.0_darwin_arm64.tar.gz
90+
91+
# Extract
92+
tar -xzf mcp-omnifocus_0.1.0_darwin_arm64.tar.gz
93+
94+
# Move to desired location
95+
mv mcp-omnifocus /usr/local/bin/
96+
mv scripts /usr/local/share/mcp-omnifocus/
97+
```
98+
99+
### Configuring Claude Desktop
100+
101+
Users must configure Claude Desktop to use the server. The configuration depends on the installation method:
102+
103+
**For Homebrew Installation (Apple Silicon):**
104+
```json
105+
{
106+
"mcpServers": {
107+
"omnifocus": {
108+
"command": "/opt/homebrew/bin/mcp-omnifocus",
109+
"args": ["-scripts", "/opt/homebrew/share/mcp-omnifocus/scripts"]
110+
}
111+
}
112+
}
113+
```
114+
115+
**For Homebrew Installation (Intel Mac):**
116+
```json
117+
{
118+
"mcpServers": {
119+
"omnifocus": {
120+
"command": "/usr/local/bin/mcp-omnifocus",
121+
"args": ["-scripts", "/usr/local/share/mcp-omnifocus/scripts"]
122+
}
123+
}
124+
}
125+
```
126+
127+
**For Manual Download/Extraction:**
128+
```json
129+
{
130+
"mcpServers": {
131+
"omnifocus": {
132+
"command": "/path/to/mcp-omnifocus",
133+
"args": ["-scripts", "/path/to/scripts"]
134+
}
135+
}
136+
}
137+
```
138+
139+
**Important**: The `-scripts` flag explicitly specifies where the JXA automation scripts are located. While the server includes auto-detection logic that works for most installation scenarios, using the `-scripts` flag ensures reliability across all installation methods and is the recommended approach.
140+
68141
## Semantic Versioning
69142

70143
Follow [Semantic Versioning](https://semver.org/):

0 commit comments

Comments
 (0)