Skip to content

docs: document XCODEBUILDMCP_CWD, showTestTiming, and per-test results#9

Open
cameroncooke wants to merge 1 commit intomainfrom
docs/per-test-timing-and-cwd
Open

docs: document XCODEBUILDMCP_CWD, showTestTiming, and per-test results#9
cameroncooke wants to merge 1 commit intomainfrom
docs/per-test-timing-and-cwd

Conversation

@cameroncooke
Copy link
Copy Markdown
Collaborator

Summary

Documents three new pieces of public surface landing in getsentry/XcodeBuildMCP#374:

  1. XCODEBUILDMCP_CWD env var for working directory override.
  2. showTestTiming config option (and XCODEBUILDMCP_SHOW_TEST_TIMING env var) toggling the per-test "Test Results:" block in text output.
  3. testCases array on the structured xcodebuildmcp.output.test-result response.

Changes

app/docs/_content/env-vars.mdx

  • Add XCODEBUILDMCP_SHOW_TEST_TIMING to the runtime config env var table.
  • New "Working directory override" section documenting XCODEBUILDMCP_CWD with usage guidance and an MCP client config example. Includes the ~/ expansion rule and the warn-and-fall-back behavior on chdir failure.

app/docs/_content/configuration.mdx

  • Add showTestTiming under "Test output" in the config.yaml example and to the runtime config reference table.

app/docs/_content/output-formats.mdx

  • New "Per-test results" section explaining the always-on testCases array shape on xcodebuildmcp.output.test-result, with a sample structured response. Calls out the JSON/text split (the showTestTiming flag is purely a text-rendering toggle) and the parameterized-Swift-Testing limitation.

Test plan

  • No em dashes (per CLAUDE.md project rule).
  • Content fits the placement rules (public docs, end user / MCP client audience).
  • Local pnpm dev render check — let me know if you want me to spin it up before merge.

Cross-reference

Pairs with XcodeBuildMCP#374. Safe to merge before or after the source PR; the docs describe behavior that ships in 2.4.

Three new pieces of public surface coming in XcodeBuildMCP 2.4:

- XCODEBUILDMCP_CWD env var for working directory override (env-vars.mdx).
  Most useful when launching XcodeBuildMCP from a host that can configure
  env vars but not the spawn directory (e.g. MCP Inspector).
- showTestTiming config option / XCODEBUILDMCP_SHOW_TEST_TIMING env var
  (configuration.mdx, env-vars.mdx). Toggles the per-test "Test Results:"
  block in text output.
- testCases array on the structured xcodebuildmcp.output.test-result
  response (output-formats.mdx). Always emitted in JSON / structured
  content; the showTestTiming flag only controls text rendering.

Tracks getsentry/XcodeBuildMCP#374.
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Apr 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
xcodebuildmcp-com Ready Ready Preview, Comment Apr 28, 2026 10:32am

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant