refactor: move allowedTools/disallowedTools parsing to parseGitHubContext

- Change allowedTools and disallowedTools from string to string[] in ParsedGitHubContext type
- Parse comma-separated environment variables into arrays in parseGitHubContext function
- Update create-prompt and install-mcp-server to use pre-parsed arrays
- Update all affected test files to use array syntax
- Eliminate duplicate parsing logic across the codebase
This commit is contained in:
Ashwin Bhat
2025-06-04 07:52:07 -07:00
parent 2c0d6b1a1e
commit c685888c3d
10 changed files with 89 additions and 90 deletions

View File

@@ -35,38 +35,35 @@ const BASE_ALLOWED_TOOLS = [
]; ];
const DISALLOWED_TOOLS = ["WebSearch", "WebFetch"]; const DISALLOWED_TOOLS = ["WebSearch", "WebFetch"];
export function buildAllowedToolsString(customAllowedTools?: string): string { export function buildAllowedToolsString(customAllowedTools?: string[]): string {
let baseTools = [...BASE_ALLOWED_TOOLS]; let baseTools = [...BASE_ALLOWED_TOOLS];
let allAllowedTools = baseTools.join(","); let allAllowedTools = baseTools.join(",");
if (customAllowedTools) { if (customAllowedTools && customAllowedTools.length > 0) {
allAllowedTools = `${allAllowedTools},${customAllowedTools}`; allAllowedTools = `${allAllowedTools},${customAllowedTools.join(",")}`;
} }
return allAllowedTools; return allAllowedTools;
} }
export function buildDisallowedToolsString( export function buildDisallowedToolsString(
customDisallowedTools?: string, customDisallowedTools?: string[],
allowedTools?: string, allowedTools?: string[],
): string { ): string {
let disallowedTools = [...DISALLOWED_TOOLS]; let disallowedTools = [...DISALLOWED_TOOLS];
// If user has explicitly allowed some hardcoded disallowed tools, remove them from disallowed list // If user has explicitly allowed some hardcoded disallowed tools, remove them from disallowed list
if (allowedTools) { if (allowedTools && allowedTools.length > 0) {
const allowedToolsArray = allowedTools
.split(",")
.map((tool) => tool.trim());
disallowedTools = disallowedTools.filter( disallowedTools = disallowedTools.filter(
(tool) => !allowedToolsArray.includes(tool), (tool) => !allowedTools.includes(tool),
); );
} }
let allDisallowedTools = disallowedTools.join(","); let allDisallowedTools = disallowedTools.join(",");
if (customDisallowedTools) { if (customDisallowedTools && customDisallowedTools.length > 0) {
if (allDisallowedTools) { if (allDisallowedTools) {
allDisallowedTools = `${allDisallowedTools},${customDisallowedTools}`; allDisallowedTools = `${allDisallowedTools},${customDisallowedTools.join(",")}`;
} else { } else {
allDisallowedTools = customDisallowedTools; allDisallowedTools = customDisallowedTools.join(",");
} }
} }
return allDisallowedTools; return allDisallowedTools;
@@ -120,8 +117,8 @@ export function prepareContext(
triggerPhrase, triggerPhrase,
...(triggerUsername && { triggerUsername }), ...(triggerUsername && { triggerUsername }),
...(customInstructions && { customInstructions }), ...(customInstructions && { customInstructions }),
...(allowedTools && { allowedTools }), ...(allowedTools.length > 0 && { allowedTools: allowedTools.join(",") }),
...(disallowedTools && { disallowedTools }), ...(disallowedTools.length > 0 && { disallowedTools: disallowedTools.join(",") }),
...(directPrompt && { directPrompt }), ...(directPrompt && { directPrompt }),
...(claudeBranch && { claudeBranch }), ...(claudeBranch && { claudeBranch }),
}; };
@@ -636,11 +633,11 @@ export async function createPrompt(
// Set allowed tools // Set allowed tools
const allAllowedTools = buildAllowedToolsString( const allAllowedTools = buildAllowedToolsString(
preparedContext.allowedTools, context.inputs.allowedTools,
); );
const allDisallowedTools = buildDisallowedToolsString( const allDisallowedTools = buildDisallowedToolsString(
preparedContext.disallowedTools, context.inputs.disallowedTools,
preparedContext.allowedTools, context.inputs.allowedTools,
); );
core.exportVariable("ALLOWED_TOOLS", allAllowedTools); core.exportVariable("ALLOWED_TOOLS", allAllowedTools);

View File

@@ -85,7 +85,6 @@ async function run() {
// Step 11: Get MCP configuration // Step 11: Get MCP configuration
const additionalMcpConfig = process.env.MCP_CONFIG || ""; const additionalMcpConfig = process.env.MCP_CONFIG || "";
const allowedTools = process.env.ALLOWED_TOOLS || "";
const mcpConfig = await prepareMcpConfig({ const mcpConfig = await prepareMcpConfig({
githubToken, githubToken,
owner: context.repository.owner, owner: context.repository.owner,
@@ -93,7 +92,7 @@ async function run() {
branch: branchInfo.currentBranch, branch: branchInfo.currentBranch,
additionalMcpConfig, additionalMcpConfig,
claudeCommentId: commentId.toString(), claudeCommentId: commentId.toString(),
allowedTools, allowedTools: context.inputs.allowedTools,
}); });
core.setOutput("mcp_config", mcpConfig); core.setOutput("mcp_config", mcpConfig);
} catch (error) { } catch (error) {

View File

@@ -28,8 +28,8 @@ export type ParsedGitHubContext = {
inputs: { inputs: {
triggerPhrase: string; triggerPhrase: string;
assigneeTrigger: string; assigneeTrigger: string;
allowedTools: string; allowedTools: string[];
disallowedTools: string; disallowedTools: string[];
customInstructions: string; customInstructions: string;
directPrompt: string; directPrompt: string;
baseBranch?: string; baseBranch?: string;
@@ -52,8 +52,14 @@ export function parseGitHubContext(): ParsedGitHubContext {
inputs: { inputs: {
triggerPhrase: process.env.TRIGGER_PHRASE ?? "@claude", triggerPhrase: process.env.TRIGGER_PHRASE ?? "@claude",
assigneeTrigger: process.env.ASSIGNEE_TRIGGER ?? "", assigneeTrigger: process.env.ASSIGNEE_TRIGGER ?? "",
allowedTools: process.env.ALLOWED_TOOLS ?? "", allowedTools: (process.env.ALLOWED_TOOLS ?? "")
disallowedTools: process.env.DISALLOWED_TOOLS ?? "", .split(",")
.map((tool) => tool.trim())
.filter((tool) => tool.length > 0),
disallowedTools: (process.env.DISALLOWED_TOOLS ?? "")
.split(",")
.map((tool) => tool.trim())
.filter((tool) => tool.length > 0),
customInstructions: process.env.CUSTOM_INSTRUCTIONS ?? "", customInstructions: process.env.CUSTOM_INSTRUCTIONS ?? "",
directPrompt: process.env.DIRECT_PROMPT ?? "", directPrompt: process.env.DIRECT_PROMPT ?? "",
baseBranch: process.env.BASE_BRANCH, baseBranch: process.env.BASE_BRANCH,

View File

@@ -7,7 +7,7 @@ type PrepareConfigParams = {
branch: string; branch: string;
additionalMcpConfig?: string; additionalMcpConfig?: string;
claudeCommentId?: string; claudeCommentId?: string;
allowedTools?: string; allowedTools: string[];
}; };
export async function prepareMcpConfig( export async function prepareMcpConfig(
@@ -23,41 +23,15 @@ export async function prepareMcpConfig(
allowedTools, allowedTools,
} = params; } = params;
try { try {
// Parse allowed tools into an array const allowedToolsList = allowedTools || [];
const allowedToolsList = allowedTools
? allowedTools.split(",").map((tool) => tool.trim())
: [];
// Check if any GitHub MCP tools are allowed
const hasGitHubMcpTools = allowedToolsList.some((tool) => const hasGitHubMcpTools = allowedToolsList.some((tool) =>
tool.startsWith("mcp__github__"), tool.startsWith("mcp__github__"),
); );
// Start with an empty servers object const baseMcpConfig: { mcpServers: Record<string, unknown> } = {
const mcpServers: Record<string, any> = {}; mcpServers: {
github_file_ops: {
// Only include github MCP server if GitHub tools are allowed
if (hasGitHubMcpTools) {
mcpServers.github = {
command: "docker",
args: [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server:sha-e9f748f", // https://github.com/github/github-mcp-server/releases/tag/v0.4.0
],
env: {
GITHUB_PERSONAL_ACCESS_TOKEN: githubToken,
},
};
}
// Always include github_file_ops server as it contains essential tools
// (mcp__github_file_ops__commit_files, mcp__github_file_ops__update_claude_comment)
// These are in the BASE_ALLOWED_TOOLS and should always be available
mcpServers.github_file_ops = {
command: "bun", command: "bun",
args: [ args: [
"run", "run",
@@ -73,11 +47,26 @@ export async function prepareMcpConfig(
GITHUB_EVENT_NAME: process.env.GITHUB_EVENT_NAME || "", GITHUB_EVENT_NAME: process.env.GITHUB_EVENT_NAME || "",
IS_PR: process.env.IS_PR || "false", IS_PR: process.env.IS_PR || "false",
}, },
},
},
}; };
const baseMcpConfig = { if (hasGitHubMcpTools) {
mcpServers, baseMcpConfig.mcpServers.github = {
command: "docker",
args: [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server:sha-e9f748f", // https://github.com/github/github-mcp-server/releases/tag/v0.4.0
],
env: {
GITHUB_PERSONAL_ACCESS_TOKEN: githubToken,
},
}; };
}
// Merge with additional MCP config if provided // Merge with additional MCP config if provided
if (additionalMcpConfig && additionalMcpConfig.trim()) { if (additionalMcpConfig && additionalMcpConfig.trim()) {

View File

@@ -652,7 +652,7 @@ describe("buildAllowedToolsString", () => {
}); });
test("should append custom tools when provided", () => { test("should append custom tools when provided", () => {
const customTools = "Tool1,Tool2,Tool3"; const customTools = ["Tool1", "Tool2", "Tool3"];
const result = buildAllowedToolsString(customTools); const result = buildAllowedToolsString(customTools);
// Base tools should be present // Base tools should be present
@@ -683,7 +683,7 @@ describe("buildDisallowedToolsString", () => {
}); });
test("should append custom disallowed tools when provided", () => { test("should append custom disallowed tools when provided", () => {
const customDisallowedTools = "BadTool1,BadTool2"; const customDisallowedTools = ["BadTool1", "BadTool2"];
const result = buildDisallowedToolsString(customDisallowedTools); const result = buildDisallowedToolsString(customDisallowedTools);
// Base disallowed tools should be present // Base disallowed tools should be present
@@ -701,8 +701,8 @@ describe("buildDisallowedToolsString", () => {
}); });
test("should remove hardcoded disallowed tools if they are in allowed tools", () => { test("should remove hardcoded disallowed tools if they are in allowed tools", () => {
const customDisallowedTools = "BadTool1,BadTool2"; const customDisallowedTools = ["BadTool1", "BadTool2"];
const allowedTools = "WebSearch,SomeOtherTool"; const allowedTools = ["WebSearch", "SomeOtherTool"];
const result = buildDisallowedToolsString( const result = buildDisallowedToolsString(
customDisallowedTools, customDisallowedTools,
allowedTools, allowedTools,
@@ -720,7 +720,7 @@ describe("buildDisallowedToolsString", () => {
}); });
test("should remove all hardcoded disallowed tools if they are all in allowed tools", () => { test("should remove all hardcoded disallowed tools if they are all in allowed tools", () => {
const allowedTools = "WebSearch,WebFetch,SomeOtherTool"; const allowedTools = ["WebSearch", "WebFetch", "SomeOtherTool"];
const result = buildDisallowedToolsString(undefined, allowedTools); const result = buildDisallowedToolsString(undefined, allowedTools);
// Both hardcoded disallowed tools should be removed // Both hardcoded disallowed tools should be removed
@@ -732,8 +732,8 @@ describe("buildDisallowedToolsString", () => {
}); });
test("should handle custom disallowed tools when all hardcoded tools are overridden", () => { test("should handle custom disallowed tools when all hardcoded tools are overridden", () => {
const customDisallowedTools = "BadTool1,BadTool2"; const customDisallowedTools = ["BadTool1", "BadTool2"];
const allowedTools = "WebSearch,WebFetch"; const allowedTools = ["WebSearch", "WebFetch"];
const result = buildDisallowedToolsString( const result = buildDisallowedToolsString(
customDisallowedTools, customDisallowedTools,
allowedTools, allowedTools,

View File

@@ -52,8 +52,10 @@ describe("prepareMcpConfig", () => {
owner: "test-owner", owner: "test-owner",
repo: "test-repo", repo: "test-repo",
branch: "test-branch", branch: "test-branch",
allowedTools: allowedTools: [
"mcp__github__create_issue,mcp__github_file_ops__commit_files", "mcp__github__create_issue",
"mcp__github_file_ops__commit_files",
],
}); });
const parsed = JSON.parse(result); const parsed = JSON.parse(result);
@@ -71,8 +73,10 @@ describe("prepareMcpConfig", () => {
owner: "test-owner", owner: "test-owner",
repo: "test-repo", repo: "test-repo",
branch: "test-branch", branch: "test-branch",
allowedTools: allowedTools: [
"mcp__github_file_ops__commit_files,mcp__github_file_ops__update_claude_comment", "mcp__github_file_ops__commit_files",
"mcp__github_file_ops__update_claude_comment",
],
}); });
const parsed = JSON.parse(result); const parsed = JSON.parse(result);
@@ -87,7 +91,7 @@ describe("prepareMcpConfig", () => {
owner: "test-owner", owner: "test-owner",
repo: "test-repo", repo: "test-repo",
branch: "test-branch", branch: "test-branch",
allowedTools: "Edit,Read,Write", allowedTools: ["Edit", "Read", "Write"],
}); });
const parsed = JSON.parse(result); const parsed = JSON.parse(result);
@@ -147,8 +151,10 @@ describe("prepareMcpConfig", () => {
repo: "test-repo", repo: "test-repo",
branch: "test-branch", branch: "test-branch",
additionalMcpConfig: additionalConfig, additionalMcpConfig: additionalConfig,
allowedTools: allowedTools: [
"mcp__github__create_issue,mcp__github_file_ops__commit_files", "mcp__github__create_issue",
"mcp__github_file_ops__commit_files",
],
}); });
const parsed = JSON.parse(result); const parsed = JSON.parse(result);
@@ -182,8 +188,10 @@ describe("prepareMcpConfig", () => {
repo: "test-repo", repo: "test-repo",
branch: "test-branch", branch: "test-branch",
additionalMcpConfig: additionalConfig, additionalMcpConfig: additionalConfig,
allowedTools: allowedTools: [
"mcp__github__create_issue,mcp__github_file_ops__commit_files", "mcp__github__create_issue",
"mcp__github_file_ops__commit_files",
],
}); });
const parsed = JSON.parse(result); const parsed = JSON.parse(result);

View File

@@ -11,8 +11,8 @@ const defaultInputs = {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
anthropicModel: "claude-3-7-sonnet-20250219", anthropicModel: "claude-3-7-sonnet-20250219",
allowedTools: "", allowedTools: [] as string[],
disallowedTools: "", disallowedTools: [] as string[],
customInstructions: "", customInstructions: "",
directPrompt: "", directPrompt: "",
useBedrock: false, useBedrock: false,

View File

@@ -62,8 +62,8 @@ describe("checkWritePermissions", () => {
inputs: { inputs: {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
directPrompt: "", directPrompt: "",
}, },

View File

@@ -242,7 +242,7 @@ describe("parseEnvVarsWithContext", () => {
...mockPullRequestCommentContext, ...mockPullRequestCommentContext,
inputs: { inputs: {
...mockPullRequestCommentContext.inputs, ...mockPullRequestCommentContext.inputs,
allowedTools: "Tool1,Tool2", allowedTools: ["Tool1", "Tool2"],
}, },
}); });
const result = prepareContext(contextWithAllowedTools, "12345"); const result = prepareContext(contextWithAllowedTools, "12345");

View File

@@ -30,8 +30,8 @@ describe("checkContainsTrigger", () => {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
directPrompt: "Fix the bug in the login form", directPrompt: "Fix the bug in the login form",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
}, },
}); });
@@ -56,8 +56,8 @@ describe("checkContainsTrigger", () => {
triggerPhrase: "/claude", triggerPhrase: "/claude",
assigneeTrigger: "", assigneeTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
}, },
}); });
@@ -228,8 +228,8 @@ describe("checkContainsTrigger", () => {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
}, },
}); });
@@ -255,8 +255,8 @@ describe("checkContainsTrigger", () => {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
}, },
}); });
@@ -282,8 +282,8 @@ describe("checkContainsTrigger", () => {
triggerPhrase: "@claude", triggerPhrase: "@claude",
assigneeTrigger: "", assigneeTrigger: "",
directPrompt: "", directPrompt: "",
allowedTools: "", allowedTools: [],
disallowedTools: "", disallowedTools: [],
customInstructions: "", customInstructions: "",
}, },
}); });