Add XCODEBUILDMCP_ENABLED_WORKFLOWS environment variable for selective workflow loading #95
Conversation
…e workflow loading - Added registerSelectedWorkflows() function to load only specified workflows - Modified main server initialization to check for XCODEBUILDMCP_ENABLED_WORKFLOWS in static mode - Updated documentation with usage examples and available workflows - Allows clients without MCP sampling to reduce context window usage
WalkthroughIntroduces selective static workflow loading via XCODEBUILDMCP_ENABLED_WORKFLOWS. Updates startup flow in static mode to register only specified workflows; dynamic mode unchanged. Adds new registerSelectedWorkflows utility. Updates README and CHANGELOG to document the environment variable and static-mode behavior. Changes
Sequence Diagram(s)sequenceDiagram
participant Env as Environment
participant Proc as Process Startup
participant Server as MCP Server
participant Registry as Tool Registry
Env->>Proc: XCODEBUILDMCP_DYNAMIC_TOOLS?
alt Dynamic Tools = true
Proc->>Registry: registerDiscoveryTools(Server)
else Static Mode
Env->>Proc: XCODEBUILDMCP_ENABLED_WORKFLOWS?
alt Enabled Workflows set
Proc->>Registry: registerSelectedWorkflows(Server, names[])
else Not set
Proc->>Registry: registerAllToolsStatic(Server)
end
end
sequenceDiagram
participant Server as MCP Server
participant ToolReg as tool-registry.registerSelectedWorkflows
participant PluginReg as loadWorkflowGroups()
Server->>ToolReg: registerSelectedWorkflows(names[])
ToolReg->>PluginReg: loadWorkflowGroups()
PluginReg-->>ToolReg: workflowGroups
loop for each name in names[]
ToolReg->>ToolReg: resolve workflow, build tool descriptors
end
ToolReg->>Server: registerTools(selectedTools)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
CHANGELOG.md (1)
3-6: Polish the entry: punctuation and capitalization for consistency.Add a terminal period and capitalize “Sampling” to match README usage.
- - **Selective Workflow Loading**: New `XCODEBUILDMCP_ENABLED_WORKFLOWS` environment variable allows loading only specific workflow groups in static mode, reducing context window usage for clients that don't support MCP sampling + - **Selective Workflow Loading**: New `XCODEBUILDMCP_ENABLED_WORKFLOWS` environment variable allows loading only specific workflow groups in static mode, reducing context window usage for clients that don't support MCP Sampling.src/utils/tool-registry.ts (1)
148-185: Harden selective loading: normalize inputs, warn on unknown workflows, and dedupe tool registrations.Currently, unknown workflow names are silently ignored and duplicate tool names across workflows could be double-registered. Trim/normalize, dedupe workflow names, guard against duplicate tool names, and warn when nothing or unknown workflows are provided. This reduces confusion and avoids potential registration errors.
export async function registerSelectedWorkflows( server: McpServer, workflowNames: string[], ): Promise<void> { - const { loadWorkflowGroups } = await import('../core/plugin-registry.js'); - const workflowGroups = await loadWorkflowGroups(); - const selectedTools = []; + const { loadWorkflowGroups } = await import('../core/plugin-registry.js'); + const workflowGroups = await loadWorkflowGroups(); + // Normalize and dedupe requested workflow names + const normalizedNames = workflowNames.map((n) => n.trim()).filter(Boolean); + const uniqueWorkflowNames = [...new Set(normalizedNames)]; + const unknownWorkflows: string[] = []; + const selectedTools: Parameters<McpServer['registerTools']>[0] = []; + const seenToolNames = new Set<string>(); - for (const workflowName of workflowNames) { - const workflow = workflowGroups.get(workflowName.trim()); - if (workflow) { - for (const tool of workflow.tools) { - selectedTools.push({ - name: tool.name, - config: { - description: tool.description ?? '', - inputSchema: tool.schema, - }, - callback: (args: unknown): Promise<ToolResponse> => - tool.handler(args as Record<string, unknown>), - }); - } - } - } + for (const workflowName of uniqueWorkflowNames) { + const workflow = workflowGroups.get(workflowName); + if (!workflow) { + unknownWorkflows.push(workflowName); + continue; + } + for (const tool of workflow.tools) { + // Avoid double registration if the same tool appears in multiple workflows + if (seenToolNames.has(tool.name)) { + log('warn', `⚠️ Skipping duplicate tool registration: ${tool.name}`); + continue; + } + seenToolNames.add(tool.name); + selectedTools.push({ + name: tool.name, + config: { + description: tool.description ?? '', + inputSchema: tool.schema, + }, + callback: (args: unknown): Promise<ToolResponse> => + tool.handler(args as Record<string, unknown>), + }); + } + } if (selectedTools.length > 0) { server.registerTools(selectedTools); } - log( - 'info', - `✅ Registered ${selectedTools.length} tools from workflows: ${workflowNames.join(', ')}`, - ); + if (unknownWorkflows.length > 0) { + log('warn', `⚠️ Unknown workflows ignored: ${unknownWorkflows.join(', ')}`); + } + if (selectedTools.length === 0) { + log('warn', `⚠️ No tools registered for requested workflows: ${uniqueWorkflowNames.join(', ')}`); + } else { + log('info', `✅ Registered ${selectedTools.length} tools from workflows: ${uniqueWorkflowNames.join(', ')}`); + } }README.md (2)
264-283: Tighten example parsing guidance and whitespace handling.Consider clarifying that names are comma-separated and trimmed; unknown names are ignored. This aligns docs with implementation and reduces user confusion.
-For clients that don't support MCP Sampling but still want to reduce context window usage, you can selectively load only specific workflows using the `XCODEBUILDMCP_ENABLED_WORKFLOWS` environment variable: +For clients that don't support MCP Sampling but still want to reduce context window usage, you can selectively load only specific workflows using the `XCODEBUILDMCP_ENABLED_WORKFLOWS` environment variable. Provide a comma-separated list; names are trimmed and matched against internal workflow keys. Unknown names are ignored:
285-301: Verify README workflow list vs generated plugin registryTried to extract workflow keys: src/core/plugin-registry.ts imports WORKFLOW_LOADERS and WORKFLOW_METADATA from ./generated-plugins.js, but a generated-plugins file is not present in the repo / source tree, so I could not confirm the README counts or that every listed workflow key exists.
Please check the following:
- README.md (lines ~285–301) — hardcoded workflow keys + tool counts (needs attention).
- src/core/plugin-registry.ts — imports the authoritative WORKFLOW_LOADERS / WORKFLOW_METADATA.
- generated-plugins.js / generated-plugins.ts — apparently generated at build time and not committed; provide its path or ensure README is generated from it.
Suggested doc tweak (minimal):
-**Available Workflows:** +**Available Workflows:** +(Tool counts are approximate and may change between versions.)Recommended actions:
- Remove or make counts dynamic (generate from generated-plugins) or keep counts but add the above disclaimer.
- If you want a full verification, please provide the generated-plugins file (or commit it / show its generated output) so I can compare the exact workflow keys against the README.
src/index.ts (1)
79-89: Parse the env list robustly and handle empty/whitespace-only values.If the env var is set to an empty string or whitespace, the current code would proceed with an empty workflow name. Normalize inputs and fallback to full static registration if nothing valid remains.
- // STATIC MODE: Check for selective workflows - const enabledWorkflows = process.env.XCODEBUILDMCP_ENABLED_WORKFLOWS; - - if (enabledWorkflows) { - const workflowNames = enabledWorkflows.split(','); - log('info', `🚀 Initializing server with selected workflows: ${workflowNames.join(', ')}`); - await registerSelectedWorkflows(server, workflowNames); - } else { - log('info', '🚀 Initializing server in static tools mode...'); - await registerAllToolsStatic(server); - } + // STATIC MODE: Check for selective workflows + const enabledWorkflows = process.env.XCODEBUILDMCP_ENABLED_WORKFLOWS; + if (typeof enabledWorkflows === 'string') { + const workflowNames = enabledWorkflows + .split(',') + .map((n) => n.trim()) + .filter(Boolean); + if (workflowNames.length > 0) { + log('info', `🚀 Initializing server with selected workflows: ${workflowNames.join(', ')}`); + await registerSelectedWorkflows(server, workflowNames); + } else { + log('warn', '⚠️ XCODEBUILDMCP_ENABLED_WORKFLOWS provided but no valid workflow names found; falling back to static all-tools.'); + log('info', '🚀 Initializing server in static tools mode...'); + await registerAllToolsStatic(server); + } + } else { + log('info', '🚀 Initializing server in static tools mode...'); + await registerAllToolsStatic(server); + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
CHANGELOG.md(1 hunks)README.md(1 hunks)src/index.ts(2 hunks)src/utils/tool-registry.ts(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (2)
src/utils/tool-registry.ts (2)
src/core/plugin-registry.ts (1)
loadWorkflowGroups(24-66)src/utils/logger.ts (1)
log(33-53)
src/index.ts (2)
src/utils/logger.ts (1)
log(33-53)src/utils/tool-registry.ts (2)
registerSelectedWorkflows(151-184)registerAllToolsStatic(189-212)
🪛 LanguageTool
CHANGELOG.md
[grammar] ~3-~3: There might be a mistake here.
Context: # Changelog ## [Unreleased] ### Added - Selective Workflow Loading: ...
(QB_NEW_EN)
[grammar] ~4-~4: There might be a mistake here.
Context: # Changelog ## [Unreleased] ### Added - Selective Workflow Loading: New `XCODE...
(QB_NEW_EN)
🔇 Additional comments (1)
src/index.ts (1)
37-41: Import looks correct and consistent with existing ESM style.The new import of registerSelectedWorkflows aligns with other .js-suffixed ESM imports used across the file.
cameroncooke
left a comment
cameroncooke
left a comment
There was a problem hiding this comment.
Great PR, thank you for your contribution!
2 participants
Summary
Adds support for selective workflow loading in static mode via the
XCODEBUILDMCP_ENABLED_WORKFLOWSenvironment variable.Problem
Clients that don't support MCP sampling cannot use dynamic tools but still want to reduce context window usage by loading only specific tool workflows.
Solution
registerSelectedWorkflows()function to load only specified workflowsXCODEBUILDMCP_ENABLED_WORKFLOWSin static modeUsage
{ "env": { "XCODEBUILDMCP_ENABLED_WORKFLOWS": "simulator,device,logging" } }Testing
Summary by CodeRabbit
New Features
Documentation