Skip to content

Commit be770db

Browse files
committed
Improve idb client troubleshooting documentation
1 parent 92e0dc3 commit be770db

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ brew tap facebook/fb
123123
brew install idb-companion
124124
```
125125

126+
The idb client is also required but XcodeBuildMCP attmepts to install it for you. If you find that the UI automation features are still not available you can install the client manually using the following command (assumes you have Python installed):
127+
128+
```bash
129+
pip install fb-idb==1.1.7
130+
```
131+
126132
> [!IMPORTANT]
127133
> Please note that UI automation features are currently in beta so there might be some rough edges. If you encounter any issues, please report them in the [issue tracker](https://github.com/cameroncooke/XcodeBuildMCP/issues).
128134

src/tools/discover_projects.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -223,17 +223,13 @@ async function _handleDiscoveryLogic(params: DiscoverProjectsParams): Promise<To
223223

224224
if (results.projects.length > 0) {
225225
responseContent.push(
226-
createTextContent(
227-
`Projects found:\n - ${results.projects.join('\n - ')}`,
228-
),
226+
createTextContent(`Projects found:\n - ${results.projects.join('\n - ')}`),
229227
);
230228
}
231229

232230
if (results.workspaces.length > 0) {
233231
responseContent.push(
234-
createTextContent(
235-
`Workspaces found:\n - ${results.workspaces.join('\n - ')}`,
236-
),
232+
createTextContent(`Workspaces found:\n - ${results.workspaces.join('\n - ')}`),
237233
);
238234
}
239235

src/utils/idb-setup.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ export function setupIdb(): void {
163163
} else {
164164
log(
165165
'warning',
166-
`${LOG_PREFIX} fb-idb Python package could not be installed. UI automation features will not be available.`,
166+
`${LOG_PREFIX} fb-idb Python package could not be installed. UI automation features will not be available. Try running 'pip install fb-idb==1.1.7' manually.`,
167167
);
168168
}
169169
} else {
@@ -188,7 +188,7 @@ export function setupIdb(): void {
188188

189189
export function createIdbNotAvailableResponse(): ToolResponse {
190190
return createTextResponse(
191-
'idb command not found. UI automation features will not be available.\n\n' +
191+
'idb command not found. UI automation features will not be available. Try running `pip install fb-idb==1.1.7` manually.\n\n' +
192192
'See section "Enabling UI Automation" in the README.',
193193
true,
194194
);

0 commit comments

Comments
 (0)