Compare commits

...

8 Commits

Author SHA1 Message Date
Colin McDonnell c2cedce1bc 0.0.142 2025-12-15 23:38:46 -08:00
Colin McDonnell e383dd33dd Clean up destructuring 2025-12-15 23:32:02 -08:00
Colin McDonnell b833cdd4af 0.0.141 2025-12-15 23:22:30 -08:00
Colin McDonnell 333ad29965 0.0.140 2025-12-15 23:04:52 -08:00
Colin McDonnell 26336d0ac2 Tool factories 2025-12-15 23:04:20 -08:00
Colin McDonnell 0fced1dfa6 Clean up init 2025-12-15 22:21:47 -08:00
Colin McDonnell 6f96458e2d Fix graphql query 2025-12-15 21:42:43 -08:00
Colin McDonnell b038fc574f Get reviews with comments 2025-12-15 21:37:46 -08:00
24 changed files with 14824 additions and 15901 deletions
+13175 -14410
View File
File diff suppressed because it is too large Load Diff
+101 -80
View File
@@ -2,6 +2,7 @@ import { mkdtemp } from "node:fs/promises";
import { tmpdir } from "node:os"; import { tmpdir } from "node:os";
import { join } from "node:path"; import { join } from "node:path";
import { flatMorph } from "@ark/util"; import { flatMorph } from "@ark/util";
import { Octokit } from "@octokit/rest";
import { encode as toonEncode } from "@toon-format/toon"; import { encode as toonEncode } from "@toon-format/toon";
import { type } from "arktype"; import { type } from "arktype";
import { agents } from "./agents/index.ts"; import { agents } from "./agents/index.ts";
@@ -11,18 +12,17 @@ import { agentsManifest } from "./external.ts";
import { ensureProgressCommentUpdated, reportProgress } from "./mcp/comment.ts"; import { ensureProgressCommentUpdated, reportProgress } from "./mcp/comment.ts";
import { createMcpConfigs } from "./mcp/config.ts"; import { createMcpConfigs } from "./mcp/config.ts";
import { startMcpHttpServer } from "./mcp/server.ts"; import { startMcpHttpServer } from "./mcp/server.ts";
import { getModes, modes } from "./modes.ts"; import { getModes, type Mode, modes } from "./modes.ts";
import packageJson from "./package.json" with { type: "json" }; import packageJson from "./package.json" with { type: "json" };
import { fetchRepoSettings, fetchWorkflowRunInfo } from "./utils/api.ts"; import { fetchRepoSettings, fetchWorkflowRunInfo, type RepoSettings } from "./utils/api.ts";
import { log } from "./utils/cli.ts"; import { log } from "./utils/cli.ts";
import { reportErrorToComment } from "./utils/errorReport.ts"; import { reportErrorToComment } from "./utils/errorReport.ts";
import { import {
parseRepoContext, parseRepoContext,
type RepoContext,
revokeGitHubInstallationToken, revokeGitHubInstallationToken,
setupGitHubInstallationToken, setupGitHubInstallationToken,
} from "./utils/github.ts"; } from "./utils/github.ts";
import { setupGitAuth, setupGitBranch, setupGitConfig } from "./utils/setup.ts"; import { setupGit, setupGitConfig } from "./utils/setup.ts";
import { Timer } from "./utils/timer.ts"; import { Timer } from "./utils/timer.ts";
// runtime validation using agents (needed for ArkType) // runtime validation using agents (needed for ArkType)
@@ -61,19 +61,16 @@ export async function main(inputs: Inputs): Promise<MainResult> {
payload = parsePayload(inputs); payload = parsePayload(inputs);
const partialCtx = await initializeContext(inputs, payload); const partialCtx = await initializeContext(inputs, payload);
const ctx = partialCtx as MainContext; const ctx = partialCtx as Context;
timer.checkpoint("initializeContext"); timer.checkpoint("initializeContext");
setupGitAuth({ const { pushRemote } = setupGit(ctx);
githubInstallationToken: ctx.githubInstallationToken, ctx.pushRemote = pushRemote;
repoContext: ctx.repoContext, timer.checkpoint("setupGit");
});
await setupTempDirectory(ctx); await setupTempDirectory(ctx);
timer.checkpoint("setupTempDirectory"); timer.checkpoint("setupTempDirectory");
setupGitBranch(ctx.payload);
await startMcpServer(ctx); await startMcpServer(ctx);
mcpServerClose = ctx.mcpServerClose; mcpServerClose = ctx.mcpServerClose;
timer.checkpoint("startMcpServer"); timer.checkpoint("startMcpServer");
@@ -84,7 +81,7 @@ export async function main(inputs: Inputs): Promise<MainResult> {
Array.isArray(ctx.payload.event.comment_ids) && Array.isArray(ctx.payload.event.comment_ids) &&
ctx.payload.event.comment_ids.length === 0 ctx.payload.event.comment_ids.length === 0
) { ) {
await reportProgress({ await reportProgress(ctx, {
body: `👍 **No approved comments found**\n\nTo use "Fix 👍s", add a 👍 reaction to one or more inline review comments you want fixed.`, body: `👍 **No approved comments found**\n\nTo use "Fix 👍s", add a 👍 reaction to one or more inline review comments you want fixed.`,
}); });
return { success: true }; return { success: true };
@@ -157,36 +154,26 @@ function getAllPossibleKeyNames(): string[] {
/** /**
* Throw an error for missing API key with helpful message linking to repo settings * Throw an error for missing API key with helpful message linking to repo settings
*/ */
async function throwMissingApiKeyError({ async function throwMissingApiKeyError(ctx: Context): Promise<never> {
agent,
repoContext,
}: {
agent: (typeof agents)[AgentName] | null;
repoContext: RepoContext;
}): Promise<never> {
const apiUrl = process.env.API_URL || "https://pullfrog.com"; const apiUrl = process.env.API_URL || "https://pullfrog.com";
const settingsUrl = `${apiUrl}/console/${repoContext.owner}/${repoContext.name}`; const settingsUrl = `${apiUrl}/console/${ctx.owner}/${ctx.name}`;
const githubRepoUrl = `https://github.com/${repoContext.owner}/${repoContext.name}`; const githubRepoUrl = `https://github.com/${ctx.owner}/${ctx.name}`;
const githubSecretsUrl = `${githubRepoUrl}/settings/secrets/actions`; const githubSecretsUrl = `${githubRepoUrl}/settings/secrets/actions`;
// for OpenCode, use a generic message since it accepts any API key // for OpenCode, use a generic message since it accepts any API key
const isOpenCode = agent?.name === "opencode"; const isOpenCode = ctx.agent?.name === "opencode";
let secretNameList: string; let secretNameList: string;
if (isOpenCode) { if (isOpenCode) {
secretNameList = secretNameList =
"any API key (e.g., `OPENCODE_API_KEY`, `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, etc.)"; "any API key (e.g., `OPENCODE_API_KEY`, `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, etc.)";
} else { } else {
const inputKeys = agent?.apiKeyNames || getAllPossibleKeyNames(); const inputKeys = ctx.agent?.apiKeyNames || getAllPossibleKeyNames();
const secretNames = inputKeys.map((key) => `\`${key.toUpperCase()}\``); const secretNames = inputKeys.map((key) => `\`${key.toUpperCase()}\``);
secretNameList = inputKeys.length === 1 ? secretNames[0] : `one of ${secretNames.join(" or ")}`; secretNameList = inputKeys.length === 1 ? secretNames[0] : `one of ${secretNames.join(" or ")}`;
} }
let message = `${ const message = `Pullfrog is configured to use ${ctx.agent.displayName}, but the associated API key was not provided.
agent === null
? "Pullfrog has no agent configured and no API keys are available in the environment."
: `Pullfrog is configured to use ${agent.displayName}, but the associated API key was not provided.`
}
To fix this, add the required secret to your GitHub repository: To fix this, add the required secret to your GitHub repository:
@@ -194,28 +181,45 @@ To fix this, add the required secret to your GitHub repository:
2. Click "New repository secret" 2. Click "New repository secret"
3. Set the name to ${secretNameList} 3. Set the name to ${secretNameList}
4. Set the value to your API key 4. Set the value to your API key
5. Click "Add secret"`; 5. Click "Add secret"
if (agent === null) { Alternatively, configure Pullfrog to use a different agent at ${settingsUrl}`;
message += `\n\nAlternatively, configure Pullfrog to use an agent at ${settingsUrl}`;
}
// report to comment if MCP context is available (server has started) // report to comment if MCP context is available (server has started)
await reportErrorToComment({ error: message }); await reportErrorToComment({ error: message });
throw new Error(message); throw new Error(message);
} }
interface MainContext { export interface Context {
// flattened from RepoContext
owner: string;
name: string;
// core fields
inputs: Inputs; inputs: Inputs;
githubInstallationToken: string; payload: Payload;
repoContext: RepoContext; repo: Awaited<ReturnType<Octokit["repos"]["get"]>>["data"];
agentName: AgentName; agentName: AgentName;
agent: (typeof agents)[AgentName]; agent: (typeof agents)[AgentName];
githubInstallationToken: string;
octokit: Octokit;
// repo settings from Pullfrog API
repoSettings: RepoSettings;
// modes for MCP tools
modes: Mode[];
// setup fields
pushRemote: string;
sharedTempDir: string; sharedTempDir: string;
payload: Payload;
// mcp fields
mcpServerUrl: string; mcpServerUrl: string;
mcpServerClose: () => Promise<void>; mcpServerClose: () => Promise<void>;
mcpServers: ReturnType<typeof createMcpConfigs>; mcpServers: ReturnType<typeof createMcpConfigs>;
// agent fields
cliPath: string; cliPath: string;
apiKey: string; apiKey: string;
apiKeys: Record<string, string>; apiKeys: Record<string, string>;
@@ -226,8 +230,14 @@ async function initializeContext(
payload: Payload payload: Payload
): Promise< ): Promise<
Omit< Omit<
MainContext, Context,
"mcpServerUrl" | "mcpServerClose" | "mcpServers" | "cliPath" | "apiKey" | "apiKeys" | "mcpServerUrl"
| "mcpServerClose"
| "mcpServers"
| "cliPath"
| "apiKey"
| "apiKeys"
| "pushRemote"
> >
> { > {
log.info(`🐸 Running pullfrog/action@${packageJson.version}...`); log.info(`🐸 Running pullfrog/action@${packageJson.version}...`);
@@ -235,39 +245,65 @@ async function initializeContext(
setupGitConfig(); setupGitConfig();
const githubInstallationToken = await setupGitHubInstallationToken(); const githubInstallationToken = await setupGitHubInstallationToken();
const repoContext = parseRepoContext(); const { owner, name } = parseRepoContext();
// create octokit instance
const octokit = new Octokit({
auth: githubInstallationToken,
});
// fetch repo data
const response = await octokit.repos.get({
owner,
repo: name,
});
const repo = response.data;
// fetch repo settings
const repoSettings = await fetchRepoSettings({
token: githubInstallationToken,
repoContext: { owner, name },
});
// resolve agent and update payload with resolved agent name // resolve agent and update payload with resolved agent name
const { agentName, agent } = await resolveAgent( const { agentName, agent } = resolveAgent({
inputs, inputs,
payload, payload,
githubInstallationToken, repoSettings,
repoContext });
);
const resolvedPayload = { ...payload, agent: agentName }; const resolvedPayload = { ...payload, agent: agentName };
// compute modes from defaults + payload overrides
const computedModes = [
...getModes({ disableProgressComment: resolvedPayload.disableProgressComment }),
...(resolvedPayload.modes || []),
];
return { return {
owner,
name,
inputs, inputs,
githubInstallationToken, githubInstallationToken,
repoContext, octokit,
repo,
agentName, agentName,
agent, agent,
payload: resolvedPayload, payload: resolvedPayload,
repoSettings,
modes: computedModes,
sharedTempDir: "", sharedTempDir: "",
}; };
} }
async function resolveAgent( function resolveAgent({
inputs: Inputs, inputs,
payload: Payload, payload,
githubInstallationToken: string, repoSettings,
repoContext: RepoContext }: {
): Promise<{ agentName: AgentName; agent: (typeof agents)[AgentName] }> { inputs: Inputs;
const repoSettings = await fetchRepoSettings({ payload: Payload;
token: githubInstallationToken, repoSettings: RepoSettings;
repoContext, }): { agentName: AgentName; agent: (typeof agents)[AgentName] } {
});
const agentOverride = process.env.AGENT_OVERRIDE as AgentName | undefined; const agentOverride = process.env.AGENT_OVERRIDE as AgentName | undefined;
const configuredAgentName = agentOverride || payload.agent || repoSettings.defaultAgent || null; const configuredAgentName = agentOverride || payload.agent || repoSettings.defaultAgent || null;
@@ -312,10 +348,8 @@ async function resolveAgent(
log.debug(`Available agents: ${availableAgentNames || "none"}`); log.debug(`Available agents: ${availableAgentNames || "none"}`);
if (availableAgents.length === 0) { if (availableAgents.length === 0) {
await throwMissingApiKeyError({ // this will be caught and reported later in validateApiKey
agent: null, throw new Error("no agents available - missing API keys");
repoContext,
});
} }
const agentName = availableAgents[0].name; const agentName = availableAgents[0].name;
@@ -324,9 +358,7 @@ async function resolveAgent(
return { agentName, agent }; return { agentName, agent };
} }
async function setupTempDirectory( async function setupTempDirectory(ctx: Context): Promise<void> {
ctx: Omit<MainContext, "payload" | "mcpServers" | "cliPath" | "apiKey">
): Promise<void> {
ctx.sharedTempDir = await mkdtemp(join(tmpdir(), "pullfrog-")); ctx.sharedTempDir = await mkdtemp(join(tmpdir(), "pullfrog-"));
process.env.PULLFROG_TEMP_DIR = ctx.sharedTempDir; process.env.PULLFROG_TEMP_DIR = ctx.sharedTempDir;
log.info(`📂 PULLFROG_TEMP_DIR has been created at ${ctx.sharedTempDir}`); log.info(`📂 PULLFROG_TEMP_DIR has been created at ${ctx.sharedTempDir}`);
@@ -352,7 +384,7 @@ function parsePayload(inputs: Inputs): Payload {
} }
} }
async function startMcpServer(ctx: MainContext): Promise<void> { async function startMcpServer(ctx: Context): Promise<void> {
// fetch the pre-created progress comment ID from the database // fetch the pre-created progress comment ID from the database
// this must be set BEFORE starting the MCP server so comment.ts can read it // this must be set BEFORE starting the MCP server so comment.ts can read it
const runId = process.env.GITHUB_RUN_ID; const runId = process.env.GITHUB_RUN_ID;
@@ -364,26 +396,18 @@ async function startMcpServer(ctx: MainContext): Promise<void> {
} }
} }
const allModes = [ const { url, close } = await startMcpHttpServer(ctx);
...getModes({ disableProgressComment: ctx.payload.disableProgressComment }),
...(ctx.payload.modes || []),
];
const { url, close } = await startMcpHttpServer({
payload: ctx.payload,
modes: allModes,
agentName: ctx.agentName,
});
ctx.mcpServerUrl = url; ctx.mcpServerUrl = url;
ctx.mcpServerClose = close; ctx.mcpServerClose = close;
log.info(`🚀 MCP server started at ${url}`); log.info(`🚀 MCP server started at ${url}`);
} }
function setupMcpServers(ctx: MainContext): void { function setupMcpServers(ctx: Context): void {
ctx.mcpServers = createMcpConfigs(ctx.mcpServerUrl); ctx.mcpServers = createMcpConfigs(ctx.mcpServerUrl);
log.debug(`📋 MCP Config: ${JSON.stringify(ctx.mcpServers, null, 2)}`); log.debug(`📋 MCP Config: ${JSON.stringify(ctx.mcpServers, null, 2)}`);
} }
async function installAgentCli(ctx: MainContext): Promise<void> { async function installAgentCli(ctx: Context): Promise<void> {
// gemini is the only agent that needs githubInstallationToken for install // gemini is the only agent that needs githubInstallationToken for install
if (ctx.agentName === "gemini") { if (ctx.agentName === "gemini") {
ctx.cliPath = await ctx.agent.install(ctx.githubInstallationToken); ctx.cliPath = await ctx.agent.install(ctx.githubInstallationToken);
@@ -392,7 +416,7 @@ async function installAgentCli(ctx: MainContext): Promise<void> {
} }
} }
async function validateApiKey(ctx: MainContext): Promise<void> { async function validateApiKey(ctx: Context): Promise<void> {
// collect all matching API keys for this agent // collect all matching API keys for this agent
const apiKeys: Record<string, string> = {}; const apiKeys: Record<string, string> = {};
for (const inputKey of ctx.agent.apiKeyNames) { for (const inputKey of ctx.agent.apiKeyNames) {
@@ -414,10 +438,7 @@ async function validateApiKey(ctx: MainContext): Promise<void> {
} }
if (Object.keys(apiKeys).length === 0) { if (Object.keys(apiKeys).length === 0) {
await throwMissingApiKeyError({ await throwMissingApiKeyError(ctx);
agent: ctx.agent,
repoContext: ctx.repoContext,
});
// unreachable - throwMissingApiKeyError always throws // unreachable - throwMissingApiKeyError always throws
return; return;
} }
@@ -427,7 +448,7 @@ async function validateApiKey(ctx: MainContext): Promise<void> {
ctx.apiKeys = apiKeys; ctx.apiKeys = apiKeys;
} }
async function runAgent(ctx: MainContext): Promise<AgentResult> { async function runAgent(ctx: Context): Promise<AgentResult> {
log.info(`Running ${ctx.agentName}...`); log.info(`Running ${ctx.agentName}...`);
// strip context from event // strip context from event
const { context: _context, ...eventWithoutContext } = ctx.payload.event; const { context: _context, ...eventWithoutContext } = ctx.payload.event;
+3 -3
View File
@@ -30,7 +30,7 @@ await mcp.call("gh_pullfrog/get_check_suite_logs", {
### review tools ### review tools
#### `get_review_comments` #### `get_review_comments`
get all line-by-line comments for a specific pull request review. get all line-by-line comments and their replies for a specific pull request review.
**parameters:** **parameters:**
- `pull_number` (number): the pull request number - `pull_number` (number): the pull request number
@@ -39,11 +39,11 @@ get all line-by-line comments for a specific pull request review.
**replaces:** `gh api repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments` **replaces:** `gh api repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments`
**returns:** **returns:**
array of review comments including: array of review comments including threaded replies:
- file path, line number, comment body - file path, line number, comment body
- side (LEFT/RIGHT) and position in diff - side (LEFT/RIGHT) and position in diff
- user, timestamps, html_url - user, timestamps, html_url
- in_reply_to_id for threaded comments - in_reply_to_id for threaded comments (replies have this set to the parent comment id)
**example:** **example:**
```typescript ```typescript
+6 -3
View File
@@ -1,16 +1,18 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const GetCheckSuiteLogs = type({ export const GetCheckSuiteLogs = type({
check_suite_id: type.number.describe("the id from check_suite.id"), check_suite_id: type.number.describe("the id from check_suite.id"),
}); });
export const GetCheckSuiteLogsTool = tool({ export function GetCheckSuiteLogsTool(ctx: Context) {
return tool({
name: "get_check_suite_logs", name: "get_check_suite_logs",
description: description:
"get workflow run logs for a failed check suite. pass check_suite.id from the webhook payload.", "get workflow run logs for a failed check suite. pass check_suite.id from the webhook payload.",
parameters: GetCheckSuiteLogs, parameters: GetCheckSuiteLogs,
execute: contextualize(async ({ check_suite_id }, ctx) => { execute: execute(ctx, async ({ check_suite_id }) => {
// get workflow runs for this specific check suite // get workflow runs for this specific check suite
const workflowRuns = await ctx.octokit.paginate( const workflowRuns = await ctx.octokit.paginate(
ctx.octokit.rest.actions.listWorkflowRunsForRepo, ctx.octokit.rest.actions.listWorkflowRunsForRepo,
@@ -92,3 +94,4 @@ export const GetCheckSuiteLogsTool = tool({
}; };
}), }),
}); });
}
+25 -27
View File
@@ -2,10 +2,11 @@ import { Octokit } from "@octokit/rest";
import { type } from "arktype"; import { type } from "arktype";
import type { Payload } from "../external.ts"; import type { Payload } from "../external.ts";
import { agentsManifest } from "../external.ts"; import { agentsManifest } from "../external.ts";
import type { Context } from "../main.ts";
import { fetchWorkflowRunInfo } from "../utils/api.ts"; import { fetchWorkflowRunInfo } from "../utils/api.ts";
import { buildPullfrogFooter, stripExistingFooter } from "../utils/buildPullfrogFooter.ts"; import { buildPullfrogFooter, stripExistingFooter } from "../utils/buildPullfrogFooter.ts";
import { getGitHubInstallationToken, parseRepoContext } from "../utils/github.ts"; import { getGitHubInstallationToken, parseRepoContext } from "../utils/github.ts";
import { contextualize, getMcpContext, tool } from "./shared.ts"; import { execute, tool } from "./shared.ts";
/** /**
* The prefix text for the initial "leaping into action" comment. * The prefix text for the initial "leaping into action" comment.
@@ -42,12 +43,13 @@ export const Comment = type({
body: type.string.describe("the comment body content"), body: type.string.describe("the comment body content"),
}); });
export const CreateCommentTool = tool({ export function CreateCommentTool(ctx: Context) {
return tool({
name: "create_issue_comment", name: "create_issue_comment",
description: description:
"Create a comment on a GitHub issue. NOTE: Do NOT use this for progress updates or status summaries - use report_progress instead, which updates the existing progress comment.", "Create a comment on a GitHub issue. NOTE: Do NOT use this for progress updates or status summaries - use report_progress instead, which updates the existing progress comment.",
parameters: Comment, parameters: Comment,
execute: contextualize(async ({ issueNumber, body }, ctx) => { execute: execute(ctx, async ({ issueNumber, body }) => {
const bodyWithFooter = addFooter(body, ctx.payload); const bodyWithFooter = addFooter(body, ctx.payload);
const result = await ctx.octokit.rest.issues.createComment({ const result = await ctx.octokit.rest.issues.createComment({
@@ -65,17 +67,19 @@ export const CreateCommentTool = tool({
}; };
}), }),
}); });
}
export const EditComment = type({ export const EditComment = type({
commentId: type.number.describe("the ID of the comment to edit"), commentId: type.number.describe("the ID of the comment to edit"),
body: type.string.describe("the new comment body content"), body: type.string.describe("the new comment body content"),
}); });
export const EditCommentTool = tool({ export function EditCommentTool(ctx: Context) {
return tool({
name: "edit_issue_comment", name: "edit_issue_comment",
description: "Edit a GitHub issue comment by its ID", description: "Edit a GitHub issue comment by its ID",
parameters: EditComment, parameters: EditComment,
execute: contextualize(async ({ commentId, body }, ctx) => { execute: execute(ctx, async ({ commentId, body }) => {
const bodyWithFooter = addFooter(body, ctx.payload); const bodyWithFooter = addFooter(body, ctx.payload);
const result = await ctx.octokit.rest.issues.updateComment({ const result = await ctx.octokit.rest.issues.updateComment({
@@ -94,6 +98,7 @@ export const EditCommentTool = tool({
}; };
}), }),
}); });
}
/** /**
* Get progress comment ID from environment variable. * Get progress comment ID from environment variable.
@@ -141,7 +146,10 @@ export const ReportProgress = type({
* Can be called directly without going through the MCP tool interface. * Can be called directly without going through the MCP tool interface.
* Returns result data if successful, undefined if comment cannot be created. * Returns result data if successful, undefined if comment cannot be created.
*/ */
export async function reportProgress({ body }: { body: string }): Promise< export async function reportProgress(
ctx: Context,
{ body }: { body: string }
): Promise<
| { | {
commentId: number; commentId: number;
url: string; url: string;
@@ -150,8 +158,6 @@ export async function reportProgress({ body }: { body: string }): Promise<
} }
| undefined | undefined
> { > {
const ctx = getMcpContext();
const bodyWithFooter = addFooter(body, ctx.payload); const bodyWithFooter = addFooter(body, ctx.payload);
const existingCommentId = getProgressCommentId(); const existingCommentId = getProgressCommentId();
@@ -200,13 +206,14 @@ export async function reportProgress({ body }: { body: string }): Promise<
}; };
} }
export const ReportProgressTool = tool({ export function ReportProgressTool(ctx: Context) {
return tool({
name: "report_progress", name: "report_progress",
description: description:
"Share progress on the associated GitHub issue/PR. Call this to post updates as you work. The first call creates a comment, subsequent calls update it. Use this throughout your work to keep stakeholders informed.", "Share progress on the associated GitHub issue/PR. Call this to post updates as you work. The first call creates a comment, subsequent calls update it. Use this throughout your work to keep stakeholders informed.",
parameters: ReportProgress, parameters: ReportProgress,
execute: contextualize(async ({ body }) => { execute: execute(ctx, async ({ body }) => {
const result = await reportProgress({ body }); const result = await reportProgress(ctx, { body });
if (!result) { if (!result) {
// gracefully handle case where no comment can be created // gracefully handle case where no comment can be created
@@ -224,6 +231,7 @@ export const ReportProgressTool = tool({
}; };
}), }),
}); });
}
/** /**
* Check if the progress comment was updated during execution * Check if the progress comment was updated during execution
@@ -236,14 +244,12 @@ export function wasProgressCommentUpdated(): boolean {
* Delete the progress comment if it exists. * Delete the progress comment if it exists.
* Used after submitting a PR review since the review body contains all necessary info. * Used after submitting a PR review since the review body contains all necessary info.
*/ */
export async function deleteProgressComment(): Promise<boolean> { export async function deleteProgressComment(ctx: Context): Promise<boolean> {
const existingCommentId = getProgressCommentId(); const existingCommentId = getProgressCommentId();
if (!existingCommentId) { if (!existingCommentId) {
return false; return false;
} }
const ctx = getMcpContext();
await ctx.octokit.rest.issues.deleteComment({ await ctx.octokit.rest.issues.deleteComment({
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -321,16 +327,6 @@ export async function ensureProgressCommentUpdated(payload?: Payload): Promise<v
return; return;
} }
// try to get payload from MCP context if available, otherwise use provided payload
let resolvedPayload: Payload | undefined;
try {
const ctx = getMcpContext();
resolvedPayload = ctx.payload;
} catch {
// MCP context not initialized, use provided payload
resolvedPayload = payload;
}
const runId = process.env.GITHUB_RUN_ID; const runId = process.env.GITHUB_RUN_ID;
const workflowRunLink = runId const workflowRunLink = runId
? `[workflow](https://github.com/${repoContext.owner}/${repoContext.name}/actions/runs/${runId})` ? `[workflow](https://github.com/${repoContext.owner}/${repoContext.name}/actions/runs/${runId})`
@@ -341,7 +337,7 @@ export async function ensureProgressCommentUpdated(payload?: Payload): Promise<v
The workflow encountered an error before any progress could be reported. Please check the ${workflowRunLink} for details.`; The workflow encountered an error before any progress could be reported. Please check the ${workflowRunLink} for details.`;
// add footer if we have payload, otherwise use plain message // add footer if we have payload, otherwise use plain message
const body = resolvedPayload ? addFooter(errorMessage, resolvedPayload) : errorMessage; const body = payload ? addFooter(errorMessage, payload) : errorMessage;
await octokit.rest.issues.updateComment({ await octokit.rest.issues.updateComment({
owner: repoContext.owner, owner: repoContext.owner,
@@ -359,12 +355,13 @@ export const ReplyToReviewComment = type({
), ),
}); });
export const ReplyToReviewCommentTool = tool({ export function ReplyToReviewCommentTool(ctx: Context) {
return tool({
name: "reply_to_review_comment", name: "reply_to_review_comment",
description: description:
"Reply to a PR review comment thread. Call this for EACH comment you address. Keep replies extremely brief (1 sentence max).", "Reply to a PR review comment thread. Call this for EACH comment you address. Keep replies extremely brief (1 sentence max).",
parameters: ReplyToReviewComment, parameters: ReplyToReviewComment,
execute: contextualize(async ({ pull_number, comment_id, body }, ctx) => { execute: execute(ctx, async ({ pull_number, comment_id, body }) => {
const bodyWithFooter = addFooter(body, ctx.payload); const bodyWithFooter = addFooter(body, ctx.payload);
const result = await ctx.octokit.rest.pulls.createReplyForReviewComment({ const result = await ctx.octokit.rest.pulls.createReplyForReviewComment({
@@ -384,3 +381,4 @@ export const ReplyToReviewCommentTool = tool({
}; };
}), }),
}); });
}
+4 -25
View File
@@ -1,7 +1,6 @@
import { type } from "arktype"; import { type } from "arktype";
import { $ } from "../utils/shell.ts"; import { $ } from "../utils/shell.ts";
import type { ToolResult } from "./shared.ts"; import { handleToolError, handleToolSuccess, tool, type ToolResult } from "./shared.ts";
import { tool } from "./shared.ts";
export const DebugShellCommand = type({}); export const DebugShellCommand = type({});
@@ -13,33 +12,13 @@ export const DebugShellCommandTool = tool({
execute: async (): Promise<ToolResult> => { execute: async (): Promise<ToolResult> => {
try { try {
const result = $("git", ["status"]); const result = $("git", ["status"]);
return handleToolSuccess({
return {
content: [
{
type: "text",
text: JSON.stringify(
{
success: true, success: true,
command: "git status", command: "git status",
output: result.trim(), output: result.trim(),
}, });
null,
2
),
},
],
};
} catch (error) { } catch (error) {
return { return handleToolError(error);
content: [
{
type: "text",
text: `Error: ${error instanceof Error ? error.message : String(error)}`,
},
],
isError: true,
};
} }
}, },
}); });
+8 -11
View File
@@ -1,6 +1,6 @@
import { type } from "arktype"; import { type } from "arktype";
import { $ } from "../utils/shell.ts"; import { $ } from "../utils/shell.ts";
import { contextualize, tool } from "./shared.ts"; import { handleToolError, handleToolSuccess, tool, type ToolResult } from "./shared.ts";
export const ListFiles = type({ export const ListFiles = type({
path: type.string path: type.string
@@ -8,12 +8,13 @@ export const ListFiles = type({
.default("."), .default("."),
}); });
// static tool - doesn't need ctx, just runs git/find commands
export const ListFilesTool = tool({ export const ListFilesTool = tool({
name: "list_files", name: "list_files",
description: description:
"List files in the repository using git ls-files. Useful for discovering the file structure and locating files.", "List files in the repository using git ls-files. Useful for discovering the file structure and locating files.",
parameters: ListFiles, parameters: ListFiles,
execute: contextualize(async ({ path }) => { execute: async ({ path }: { path?: string }): Promise<ToolResult> => {
try { try {
// Use git ls-files to list tracked files // Use git ls-files to list tracked files
// This respects .gitignore and gives a clean list of source files // This respects .gitignore and gives a clean list of source files
@@ -30,19 +31,15 @@ export const ListFilesTool = tool({
[pathStr, "-maxdepth", "3", "-not", "-path", "*/.*", "-type", "f"], [pathStr, "-maxdepth", "3", "-not", "-path", "*/.*", "-type", "f"],
{ log: false } { log: false }
); );
return { return handleToolSuccess({
files: findOutput.split("\n").filter((f) => f.trim() !== ""), files: findOutput.split("\n").filter((f) => f.trim() !== ""),
method: "find", method: "find",
}; });
} }
return { files, method: "git" }; return handleToolSuccess({ files, method: "git" });
} catch (error) { } catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error); return handleToolError(error);
return {
error: `Failed to list files: ${errorMessage}`,
hint: "Try using a specific path if the repository root is not the current directory.",
};
} }
}), },
}); });
+36 -19
View File
@@ -1,22 +1,31 @@
import { type } from "arktype"; import { type } from "arktype";
import type { Context } from "../main.ts";
import { log } from "../utils/cli.ts"; import { log } from "../utils/cli.ts";
import { containsSecrets } from "../utils/secrets.ts"; import { containsSecrets } from "../utils/secrets.ts";
import { $ } from "../utils/shell.ts"; import { $ } from "../utils/shell.ts";
import { contextualize, tool } from "./shared.ts"; import { execute, tool } from "./shared.ts";
export const CreateBranch = type({ export function CreateBranchTool(ctx: Context) {
const defaultBranch = ctx.repo.default_branch || "main";
const CreateBranch = type({
branchName: type.string.describe( branchName: type.string.describe(
"The name of the branch to create (e.g., 'pullfrog/123-fix-bug')" "The name of the branch to create (e.g., 'pullfrog/123-fix-bug')"
), ),
baseBranch: type.string.describe("The base branch to create from (e.g., 'main')").default("main"), baseBranch: type.string
.describe(`The base branch to create from (defaults to '${defaultBranch}')`)
.default(defaultBranch),
}); });
export const CreateBranchTool = tool({ return tool({
name: "create_branch", name: "create_branch",
description: description:
"Create a new git branch from the specified base branch. The branch will be created locally and pushed to the remote repository.", "Create a new git branch from the specified base branch. The branch will be created locally and pushed to the remote repository.",
parameters: CreateBranch, parameters: CreateBranch,
execute: contextualize(async ({ branchName, baseBranch }) => { execute: execute(ctx, async ({ branchName, baseBranch }) => {
// baseBranch should always be defined due to default, but TypeScript needs help
const resolvedBaseBranch = baseBranch || ctx.repo.default_branch || "main";
// validate branch name for secrets // validate branch name for secrets
if (containsSecrets(branchName)) { if (containsSecrets(branchName)) {
throw new Error( throw new Error(
@@ -25,14 +34,14 @@ export const CreateBranchTool = tool({
); );
} }
log.info(`Creating branch ${branchName} from ${baseBranch}`); log.info(`Creating branch ${branchName} from ${resolvedBaseBranch}`);
// fetch base branch to ensure we're up to date // fetch base branch to ensure we're up to date
$("git", ["fetch", "origin", baseBranch, "--depth=1"]); $("git", ["fetch", "origin", resolvedBaseBranch, "--depth=1"]);
// checkout base branch, ensuring it matches the remote version // checkout base branch, ensuring it matches the remote version
// -B creates or resets the branch to match origin/baseBranch // -B creates or resets the branch to match origin/baseBranch
$("git", ["checkout", "-B", baseBranch, `origin/${baseBranch}`]); $("git", ["checkout", "-B", resolvedBaseBranch, `origin/${resolvedBaseBranch}`]);
// create and checkout new branch // create and checkout new branch
$("git", ["checkout", "-b", branchName]); $("git", ["checkout", "-b", branchName]);
@@ -45,11 +54,12 @@ export const CreateBranchTool = tool({
return { return {
success: true, success: true,
branchName, branchName,
baseBranch, baseBranch: resolvedBaseBranch,
message: `Branch ${branchName} created from ${baseBranch} and pushed to remote`, message: `Branch ${branchName} created from ${resolvedBaseBranch} and pushed to remote`,
}; };
}), }),
}); });
}
export const CommitFiles = type({ export const CommitFiles = type({
message: type.string.describe("The commit message"), message: type.string.describe("The commit message"),
@@ -60,12 +70,13 @@ export const CommitFiles = type({
), ),
}); });
export const CommitFilesTool = tool({ export function CommitFilesTool(ctx: Context) {
return tool({
name: "commit_files", name: "commit_files",
description: description:
"Stage and commit files with a commit message. If files array is empty, commits all staged changes. The commit will be attributed to the correct bot account.", "Stage and commit files with a commit message. If files array is empty, commits all staged changes. The commit will be attributed to the correct bot account.",
parameters: CommitFiles, parameters: CommitFiles,
execute: contextualize(async ({ message, files }) => { execute: execute(ctx, async ({ message, files }) => {
// validate commit message for secrets // validate commit message for secrets
if (containsSecrets(message)) { if (containsSecrets(message)) {
throw new Error( throw new Error(
@@ -121,6 +132,7 @@ export const CommitFilesTool = tool({
}; };
}), }),
}); });
}
export const PushBranch = type({ export const PushBranch = type({
branchName: type.string branchName: type.string
@@ -129,27 +141,32 @@ export const PushBranch = type({
force: type.boolean.describe("Force push (use with caution)").default(false), force: type.boolean.describe("Force push (use with caution)").default(false),
}); });
export const PushBranchTool = tool({ export function PushBranchTool(ctx: Context) {
const remote = ctx.pushRemote;
return tool({
name: "push_branch", name: "push_branch",
description: description:
"Push the current branch (or specified branch) to the remote repository. Never force push unless explicitly requested.", "Push the current branch (or specified branch) to the remote repository. Never force push unless explicitly requested.",
parameters: PushBranch, parameters: PushBranch,
execute: contextualize(async ({ branchName, force }) => { execute: execute(ctx, async ({ branchName, force }) => {
const branch = branchName || $("git", ["rev-parse", "--abbrev-ref", "HEAD"], { log: false }); const branch = branchName || $("git", ["rev-parse", "--abbrev-ref", "HEAD"], { log: false });
log.info(`Pushing branch ${branch} to ${remote}`);
if (force) { if (force) {
log.warning(`Force pushing branch ${branch} - this will overwrite remote history`); log.warning(`Force pushing - this will overwrite remote history`);
$("git", ["push", "--force", "origin", branch]); $("git", ["push", "--force", "-u", remote, branch]);
} else { } else {
log.info(`Pushing branch ${branch} to remote`); $("git", ["push", "-u", remote, branch]);
$("git", ["push", "origin", branch]);
} }
return { return {
success: true, success: true,
branch, branch,
remote,
force, force,
message: `Successfully pushed branch ${branch} to remote`, message: `Successfully pushed branch ${branch} to ${remote}`,
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,5 +1,6 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const Issue = type({ export const Issue = type({
title: type.string.describe("the title of the issue"), title: type.string.describe("the title of the issue"),
@@ -14,11 +15,12 @@ export const Issue = type({
.optional(), .optional(),
}); });
export const IssueTool = tool({ export function IssueTool(ctx: Context) {
return tool({
name: "create_issue", name: "create_issue",
description: "Create a new GitHub issue", description: "Create a new GitHub issue",
parameters: Issue, parameters: Issue,
execute: contextualize(async ({ title, body, labels, assignees }, ctx) => { execute: execute(ctx, async ({ title, body, labels, assignees }) => {
const result = await ctx.octokit.rest.issues.create({ const result = await ctx.octokit.rest.issues.create({
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -40,3 +42,4 @@ export const IssueTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,16 +1,18 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const GetIssueComments = type({ export const GetIssueComments = type({
issue_number: type.number.describe("The issue number to get comments for"), issue_number: type.number.describe("The issue number to get comments for"),
}); });
export const GetIssueCommentsTool = tool({ export function GetIssueCommentsTool(ctx: Context) {
return tool({
name: "get_issue_comments", name: "get_issue_comments",
description: description:
"Get all comments for a GitHub issue. Returns all comments including the issue body and all subsequent discussion comments.", "Get all comments for a GitHub issue. Returns all comments including the issue body and all subsequent discussion comments.",
parameters: GetIssueComments, parameters: GetIssueComments,
execute: contextualize(async ({ issue_number }, ctx) => { execute: execute(ctx, async ({ issue_number }) => {
const comments = await ctx.octokit.paginate(ctx.octokit.rest.issues.listComments, { const comments = await ctx.octokit.paginate(ctx.octokit.rest.issues.listComments, {
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -33,3 +35,4 @@ export const GetIssueCommentsTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,16 +1,18 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const GetIssueEvents = type({ export const GetIssueEvents = type({
issue_number: type.number.describe("The issue number to get events for"), issue_number: type.number.describe("The issue number to get events for"),
}); });
export const GetIssueEventsTool = tool({ export function GetIssueEventsTool(ctx: Context) {
return tool({
name: "get_issue_events", name: "get_issue_events",
description: description:
"Get timeline events for a GitHub issue that aren't reflected in the current state. Returns cross-references to other issues/PRs and commit references. Note: current labels, assignees, state, and milestone are already available via get_issue.", "Get timeline events for a GitHub issue that aren't reflected in the current state. Returns cross-references to other issues/PRs and commit references. Note: current labels, assignees, state, and milestone are already available via get_issue.",
parameters: GetIssueEvents, parameters: GetIssueEvents,
execute: contextualize(async ({ issue_number }, ctx) => { execute: execute(ctx, async ({ issue_number }) => {
const events = await ctx.octokit.paginate(ctx.octokit.rest.issues.listEventsForTimeline, { const events = await ctx.octokit.paginate(ctx.octokit.rest.issues.listEventsForTimeline, {
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -91,3 +93,4 @@ export const GetIssueEventsTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,15 +1,17 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const IssueInfo = type({ export const IssueInfo = type({
issue_number: type.number.describe("The issue number to fetch"), issue_number: type.number.describe("The issue number to fetch"),
}); });
export const IssueInfoTool = tool({ export function IssueInfoTool(ctx: Context) {
return tool({
name: "get_issue", name: "get_issue",
description: "Retrieve GitHub issue information by issue number", description: "Retrieve GitHub issue information by issue number",
parameters: IssueInfo, parameters: IssueInfo,
execute: contextualize(async ({ issue_number }, ctx) => { execute: execute(ctx, async ({ issue_number }) => {
const issue = await ctx.octokit.rest.issues.get({ const issue = await ctx.octokit.rest.issues.get({
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -53,3 +55,4 @@ export const IssueInfoTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,17 +1,19 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const AddLabelsParams = type({ export const AddLabelsParams = type({
issue_number: type.number.describe("the issue or PR number to add labels to"), issue_number: type.number.describe("the issue or PR number to add labels to"),
labels: type.string.array().atLeastLength(1).describe("array of label names to add"), labels: type.string.array().atLeastLength(1).describe("array of label names to add"),
}); });
export const AddLabelsTool = tool({ export function AddLabelsTool(ctx: Context) {
return tool({
name: "add_labels", name: "add_labels",
description: description:
"Add labels to a GitHub issue or pull request. Only use labels that already exist in the repository.", "Add labels to a GitHub issue or pull request. Only use labels that already exist in the repository.",
parameters: AddLabelsParams, parameters: AddLabelsParams,
execute: contextualize(async ({ issue_number, labels }, ctx) => { execute: execute(ctx, async ({ issue_number, labels }) => {
const result = await ctx.octokit.rest.issues.addLabels({ const result = await ctx.octokit.rest.issues.addLabels({
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -25,3 +27,4 @@ export const AddLabelsTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,8 +1,9 @@
import { type } from "arktype"; import { type } from "arktype";
import type { Context } from "../main.ts";
import { log } from "../utils/cli.ts"; import { log } from "../utils/cli.ts";
import { containsSecrets } from "../utils/secrets.ts"; import { containsSecrets } from "../utils/secrets.ts";
import { $ } from "../utils/shell.ts"; import { $ } from "../utils/shell.ts";
import { contextualize, tool } from "./shared.ts"; import { execute, tool } from "./shared.ts";
export const PullRequest = type({ export const PullRequest = type({
title: type.string.describe("the title of the pull request"), title: type.string.describe("the title of the pull request"),
@@ -10,11 +11,12 @@ export const PullRequest = type({
base: type.string.describe("the base branch to merge into (e.g., 'main')"), base: type.string.describe("the base branch to merge into (e.g., 'main')"),
}); });
export const PullRequestTool = tool({ export function PullRequestTool(ctx: Context) {
return tool({
name: "create_pull_request", name: "create_pull_request",
description: "Create a pull request from the current branch", description: "Create a pull request from the current branch",
parameters: PullRequest, parameters: PullRequest,
execute: contextualize(async ({ title, body, base }, ctx) => { execute: execute(ctx, async ({ title, body, base }) => {
const currentBranch = $("git", ["rev-parse", "--abbrev-ref", "HEAD"], { log: false }); const currentBranch = $("git", ["rev-parse", "--abbrev-ref", "HEAD"], { log: false });
log.info(`Current branch: ${currentBranch}`); log.info(`Current branch: ${currentBranch}`);
@@ -55,3 +57,4 @@ export const PullRequestTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,16 +1,18 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const PullRequestInfo = type({ export const PullRequestInfo = type({
pull_number: type.number.describe("The pull request number to fetch"), pull_number: type.number.describe("The pull request number to fetch"),
}); });
export const PullRequestInfoTool = tool({ export function PullRequestInfoTool(ctx: Context) {
return tool({
name: "get_pull_request", name: "get_pull_request",
description: description:
"Retrieve PR information (metadata only). PR branch is already checked out during setup.", "Retrieve PR information (metadata only). PR branch is already checked out during setup.",
parameters: PullRequestInfo, parameters: PullRequestInfo,
execute: contextualize(async ({ pull_number }, ctx) => { execute: execute(ctx, async ({ pull_number }) => {
const pr = await ctx.octokit.rest.pulls.get({ const pr = await ctx.octokit.rest.pulls.get({
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -35,3 +37,4 @@ export const PullRequestInfoTool = tool({
}; };
}), }),
}); });
}
+7 -4
View File
@@ -1,8 +1,9 @@
import type { RestEndpointMethodTypes } from "@octokit/rest"; import type { RestEndpointMethodTypes } from "@octokit/rest";
import { type } from "arktype"; import { type } from "arktype";
import type { Context } from "../main.ts";
import { buildPullfrogFooter } from "../utils/buildPullfrogFooter.ts"; import { buildPullfrogFooter } from "../utils/buildPullfrogFooter.ts";
import { deleteProgressComment } from "./comment.ts"; import { deleteProgressComment } from "./comment.ts";
import { contextualize, tool } from "./shared.ts"; import { execute, tool } from "./shared.ts";
export const Review = type({ export const Review = type({
pull_number: type.number.describe("The pull request number to review"), pull_number: type.number.describe("The pull request number to review"),
@@ -39,14 +40,15 @@ export const Review = type({
.optional(), .optional(),
}); });
export const ReviewTool = tool({ export function ReviewTool(ctx: Context) {
return tool({
name: "submit_pull_request_review", name: "submit_pull_request_review",
description: description:
"Submit a review for an existing pull request. " + "Submit a review for an existing pull request. " +
"IMPORTANT: 95%+ of feedback should be in 'comments' array with file paths and line numbers. " + "IMPORTANT: 95%+ of feedback should be in 'comments' array with file paths and line numbers. " +
"Only use 'body' for a 1-2 sentence summary with urgency and critical callouts.", "Only use 'body' for a 1-2 sentence summary with urgency and critical callouts.",
parameters: Review, parameters: Review,
execute: contextualize(async ({ pull_number, body, commit_id, comments = [] }, ctx) => { execute: execute(ctx, async ({ pull_number, body, commit_id, comments = [] }) => {
// get the PR to determine the head commit if commit_id not provided // get the PR to determine the head commit if commit_id not provided
const pr = await ctx.octokit.rest.pulls.get({ const pr = await ctx.octokit.rest.pulls.get({
owner: ctx.owner, owner: ctx.owner,
@@ -105,7 +107,7 @@ export const ReviewTool = tool({
body: updatedBody, body: updatedBody,
}); });
await deleteProgressComment(); await deleteProgressComment(ctx);
return { return {
success: true, success: true,
@@ -117,3 +119,4 @@ export const ReviewTool = tool({
}; };
}), }),
}); });
}
+170 -26
View File
@@ -1,58 +1,201 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
// graphql query to fetch all review threads with comments and replies
// note: diffSide and startDiffSide are on the thread, not the comment
const REVIEW_THREADS_QUERY = `
query ($owner: String!, $repo: String!, $pullNumber: Int!) {
repository(owner: $owner, name: $repo) {
pullRequest(number: $pullNumber) {
reviewThreads(first: 100) {
nodes {
diffSide
startDiffSide
comments(first: 100) {
nodes {
id
databaseId
body
path
line
startLine
url
author {
login
}
createdAt
updatedAt
pullRequestReview {
databaseId
}
replyTo {
databaseId
}
}
}
}
}
}
}
}
`;
// graphql response types (nodes arrays can contain nulls per GitHub GraphQL spec)
type GraphQLReviewComment = {
id: string;
databaseId: number;
body: string;
path: string;
line: number | null;
startLine: number | null;
url: string;
author: {
login: string;
} | null;
createdAt: string;
updatedAt: string;
pullRequestReview: {
databaseId: number;
} | null;
replyTo: {
databaseId: number;
} | null;
};
type GraphQLReviewThread = {
diffSide: "LEFT" | "RIGHT";
startDiffSide: "LEFT" | "RIGHT" | null;
comments: {
nodes: (GraphQLReviewComment | null)[] | null;
} | null;
} | null;
type GraphQLResponse = {
repository: {
pullRequest: {
reviewThreads: {
nodes: (GraphQLReviewThread | null)[] | null;
} | null;
} | null;
} | null;
};
export const GetReviewComments = type({ export const GetReviewComments = type({
pull_number: type.number.describe("The pull request number"), pull_number: type.number.describe("The pull request number"),
review_id: type.number.describe("The review ID to get comments for"), review_id: type.number.describe("The review ID to get comments for"),
}); });
export const GetReviewCommentsTool = tool({ export function GetReviewCommentsTool(ctx: Context) {
return tool({
name: "get_review_comments", name: "get_review_comments",
description: description:
"Get all review comments for a specific pull request review. Returns line-by-line comments that were left on specific code locations.", "Get all review comments and their replies for a specific pull request review. Returns line-by-line comments that were left on specific code locations, including any threaded replies.",
parameters: GetReviewComments, parameters: GetReviewComments,
execute: contextualize(async ({ pull_number, review_id }, ctx) => { execute: execute(ctx, async ({ pull_number, review_id }) => {
const comments = await ctx.octokit.paginate(ctx.octokit.rest.pulls.listCommentsForReview, { // fetch all review threads using graphql
const response = await ctx.octokit.graphql<GraphQLResponse>(REVIEW_THREADS_QUERY, {
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
pull_number, pullNumber: pull_number,
review_id,
}); });
const pullRequest = response.repository?.pullRequest;
if (!pullRequest) {
return {
review_id,
pull_number,
comments: [],
count: 0,
};
}
const threadNodes = pullRequest.reviewThreads?.nodes;
if (!threadNodes) {
return {
review_id,
pull_number,
comments: [],
count: 0,
};
}
const allComments: {
id: number;
body: string;
path: string;
line: number | null;
side: "LEFT" | "RIGHT";
start_line: number | null;
start_side: "LEFT" | "RIGHT" | null;
user: string | null;
created_at: string;
updated_at: string;
html_url: string;
in_reply_to_id: number | null;
pull_request_review_id: number | null;
}[] = [];
// iterate through all threads (filter out nulls)
for (const thread of threadNodes) {
if (!thread?.comments?.nodes) continue;
// filter out null comments
const threadComments = thread.comments.nodes.filter(
(c): c is GraphQLReviewComment => c !== null
);
if (threadComments.length === 0) continue;
// find the root comment (the one with replyTo == null) to determine thread ownership
const rootComment = threadComments.find((c) => c.replyTo === null);
if (!rootComment) continue;
// check if this thread belongs to the target review using the root comment
const threadBelongsToReview = rootComment.pullRequestReview?.databaseId === review_id;
if (!threadBelongsToReview) continue;
// include all comments from this thread (original + replies)
// side info comes from thread level, not comment level
for (const comment of threadComments) {
allComments.push({
id: comment.databaseId,
body: comment.body,
path: comment.path,
line: comment.line,
start_line: comment.startLine,
side: thread.diffSide,
start_side: thread.startDiffSide,
user: comment.author?.login ?? null,
created_at: comment.createdAt,
updated_at: comment.updatedAt,
html_url: comment.url,
in_reply_to_id: comment.replyTo?.databaseId ?? null,
pull_request_review_id: comment.pullRequestReview?.databaseId ?? null,
});
}
}
return { return {
review_id, review_id,
pull_number, pull_number,
comments: comments.map((comment) => ({ comments: allComments,
id: comment.id, count: allComments.length,
body: comment.body,
path: comment.path,
line: comment.line,
side: comment.side,
start_line: comment.start_line,
start_side: comment.start_side,
user: typeof comment.user === "string" ? comment.user : comment.user?.login,
created_at: comment.created_at,
updated_at: comment.updated_at,
html_url: comment.html_url,
in_reply_to_id: comment.in_reply_to_id,
diff_hunk: comment.diff_hunk,
reactions: comment.reactions,
})),
count: comments.length,
}; };
}), }),
}); });
}
export const ListPullRequestReviews = type({ export const ListPullRequestReviews = type({
pull_number: type.number.describe("The pull request number to list reviews for"), pull_number: type.number.describe("The pull request number to list reviews for"),
}); });
export const ListPullRequestReviewsTool = tool({ export function ListPullRequestReviewsTool(ctx: Context) {
return tool({
name: "list_pull_request_reviews", name: "list_pull_request_reviews",
description: description:
"List all reviews for a pull request. Returns all reviews including approvals, request changes, and comments.", "List all reviews for a pull request. Returns all reviews including approvals, request changes, and comments.",
parameters: ListPullRequestReviews, parameters: ListPullRequestReviews,
execute: contextualize(async ({ pull_number }, ctx) => { execute: execute(ctx, async ({ pull_number }) => {
const reviews = await ctx.octokit.paginate(ctx.octokit.rest.pulls.listReviews, { const reviews = await ctx.octokit.paginate(ctx.octokit.rest.pulls.listReviews, {
owner: ctx.owner, owner: ctx.owner,
repo: ctx.name, repo: ctx.name,
@@ -74,3 +217,4 @@ export const ListPullRequestReviewsTool = tool({
}; };
}), }),
}); });
}
+6 -3
View File
@@ -1,5 +1,6 @@
import { type } from "arktype"; import { type } from "arktype";
import { contextualize, tool } from "./shared.ts"; import type { Context } from "../main.ts";
import { execute, tool } from "./shared.ts";
export const SelectMode = type({ export const SelectMode = type({
modeName: type.string.describe( modeName: type.string.describe(
@@ -7,12 +8,13 @@ export const SelectMode = type({
), ),
}); });
export const SelectModeTool = tool({ export function SelectModeTool(ctx: Context) {
return tool({
name: "select_mode", name: "select_mode",
description: description:
"Select a mode and get its detailed prompt instructions. Call this first to determine which mode to use based on the request.", "Select a mode and get its detailed prompt instructions. Call this first to determine which mode to use based on the request.",
parameters: SelectMode, parameters: SelectMode,
execute: contextualize(async ({ modeName }, ctx) => { execute: execute(ctx, async ({ modeName }) => {
const selectedMode = ctx.modes.find((m) => m.name.toLowerCase() === modeName.toLowerCase()); const selectedMode = ctx.modes.find((m) => m.name.toLowerCase() === modeName.toLowerCase());
if (!selectedMode) { if (!selectedMode) {
@@ -30,3 +32,4 @@ export const SelectModeTool = tool({
}; };
}), }),
}); });
}
+25 -30
View File
@@ -3,6 +3,7 @@ import "./arkConfig.ts";
import { createServer } from "node:net"; import { createServer } from "node:net";
import { FastMCP, type Tool } from "fastmcp"; import { FastMCP, type Tool } from "fastmcp";
import { ghPullfrogMcpName } from "../external.ts"; import { ghPullfrogMcpName } from "../external.ts";
import type { Context } from "../main.ts";
import { GetCheckSuiteLogsTool } from "./checkSuite.ts"; import { GetCheckSuiteLogsTool } from "./checkSuite.ts";
import { import {
CreateCommentTool, CreateCommentTool,
@@ -22,12 +23,7 @@ import { PullRequestInfoTool } from "./prInfo.ts";
import { ReviewTool } from "./review.ts"; import { ReviewTool } from "./review.ts";
import { GetReviewCommentsTool, ListPullRequestReviewsTool } from "./reviewComments.ts"; import { GetReviewCommentsTool, ListPullRequestReviewsTool } from "./reviewComments.ts";
import { SelectModeTool } from "./selectMode.ts"; import { SelectModeTool } from "./selectMode.ts";
import { import { addTools, isProgressCommentDisabled } from "./shared.ts";
addTools,
initMcpContext,
isProgressCommentDisabled,
type McpInitContext,
} from "./shared.ts";
/** /**
* Find an available port starting from the given port * Find an available port starting from the given port
@@ -62,43 +58,42 @@ async function findAvailablePort(startPort: number): Promise<number> {
* Start the MCP HTTP server and return the URL and close function * Start the MCP HTTP server and return the URL and close function
*/ */
export async function startMcpHttpServer( export async function startMcpHttpServer(
state: McpInitContext ctx: Context
): Promise<{ url: string; close: () => Promise<void> }> { ): Promise<{ url: string; close: () => Promise<void> }> {
initMcpContext(state);
const server = new FastMCP({ const server = new FastMCP({
name: ghPullfrogMcpName, name: ghPullfrogMcpName,
version: "0.0.1", version: "0.0.1",
}); });
// create all tools as factories, passing ctx
const tools: Tool<any, any>[] = [ const tools: Tool<any, any>[] = [
SelectModeTool, SelectModeTool(ctx),
CreateCommentTool, CreateCommentTool(ctx),
EditCommentTool, EditCommentTool(ctx),
ReplyToReviewCommentTool, ReplyToReviewCommentTool(ctx),
IssueTool, IssueTool(ctx),
IssueInfoTool, IssueInfoTool(ctx),
GetIssueCommentsTool, GetIssueCommentsTool(ctx),
GetIssueEventsTool, GetIssueEventsTool(ctx),
PullRequestTool, PullRequestTool(ctx),
ReviewTool, ReviewTool(ctx),
PullRequestInfoTool, PullRequestInfoTool(ctx),
GetReviewCommentsTool, GetReviewCommentsTool(ctx),
ListPullRequestReviewsTool, ListPullRequestReviewsTool(ctx),
GetCheckSuiteLogsTool, GetCheckSuiteLogsTool(ctx),
DebugShellCommandTool, DebugShellCommandTool,
AddLabelsTool, AddLabelsTool(ctx),
CreateBranchTool, CreateBranchTool(ctx),
CommitFilesTool, CommitFilesTool(ctx),
PushBranchTool, PushBranchTool(ctx),
]; ];
// only include ReportProgressTool if progress comment is not disabled // only include ReportProgressTool if progress comment is not disabled
if (!isProgressCommentDisabled()) { if (!isProgressCommentDisabled(ctx)) {
tools.push(ReportProgressTool); tools.push(ReportProgressTool(ctx));
} }
addTools(server, tools); addTools(ctx, server, tools);
const port = await findAvailablePort(3764); const port = await findAvailablePort(3764);
const host = "127.0.0.1"; const host = "127.0.0.1";
+54 -87
View File
@@ -1,46 +1,60 @@
import { Octokit } from "@octokit/rest";
import type { StandardSchemaV1 } from "@standard-schema/spec"; import type { StandardSchemaV1 } from "@standard-schema/spec";
import type { FastMCP, Tool } from "fastmcp"; import type { FastMCP, Tool } from "fastmcp";
import type { Payload } from "../external.ts"; import type { Context } from "../main.ts";
import type { Mode } from "../modes.ts";
import { getGitHubInstallationToken, parseRepoContext, type RepoContext } from "../utils/github.ts";
export interface McpInitContext {
payload: Payload;
modes: Mode[];
agentName?: string;
}
let mcpInitContext: McpInitContext | undefined;
// this must be called on mcp server initialization
export function initMcpContext(state: McpInitContext): void {
mcpInitContext = state;
}
export interface McpContext extends McpInitContext, RepoContext {
octokit: Octokit;
}
export function getMcpContext(): McpContext {
if (!mcpInitContext) {
throw new Error("MCP context not initialized. Call initializeMcpContext first.");
}
return {
...mcpInitContext,
...parseRepoContext(),
octokit: new Octokit({
auth: getGitHubInstallationToken(),
}),
};
}
export function isProgressCommentDisabled(): boolean {
return mcpInitContext?.payload.disableProgressComment === true;
}
export const tool = <const params>(toolDef: Tool<any, StandardSchemaV1<params>>) => toolDef; export const tool = <const params>(toolDef: Tool<any, StandardSchemaV1<params>>) => toolDef;
export interface ToolResult {
content: {
type: "text";
text: string;
}[];
isError?: boolean;
}
export const handleToolSuccess = (data: Record<string, any>): ToolResult => {
return {
content: [
{
type: "text",
text: JSON.stringify(data, null, 2),
},
],
};
};
export const handleToolError = (error: unknown): ToolResult => {
const errorMessage = error instanceof Error ? error.message : String(error);
return {
content: [
{
type: "text",
text: `Error: ${errorMessage}`,
},
],
isError: true,
};
};
/**
* Helper to wrap a tool execute function with error handling.
* Captures ctx in closure so tools don't need to handle try/catch.
*/
export const execute = <T>(ctx: Context, fn: (params: T) => Promise<Record<string, any>>) => {
return async (params: T): Promise<ToolResult> => {
try {
const result = await fn(params);
return handleToolSuccess(result);
} catch (error) {
return handleToolError(error);
}
};
};
export function isProgressCommentDisabled(ctx: Context): boolean {
return ctx.payload.disableProgressComment === true;
}
/** /**
* Sanitize JSON schema to remove problematic fields that Gemini CLI/API can't handle * Sanitize JSON schema to remove problematic fields that Gemini CLI/API can't handle
* - Removes $schema field (causes "no schema with key or ref" errors) * - Removes $schema field (causes "no schema with key or ref" errors)
@@ -162,11 +176,10 @@ function sanitizeTool<T extends Tool<any, any>>(tool: T): T {
} as T; } as T;
} }
export const addTools = (server: FastMCP, tools: Tool<any, any>[]) => { export const addTools = (ctx: Context, server: FastMCP, tools: Tool<any, any>[]) => {
// sanitize schemas for gemini agent and opencode (when using Google API) // sanitize schemas for gemini agent and opencode (when using Google API)
// both have issues with draft-2020-12 schemas and any_of enum constructs // both have issues with draft-2020-12 schemas and any_of enum constructs
const shouldSanitize = const shouldSanitize = ctx.agentName === "gemini" || ctx.agentName === "opencode";
mcpInitContext?.agentName === "gemini" || mcpInitContext?.agentName === "opencode";
for (const tool of tools) { for (const tool of tools) {
const processedTool = shouldSanitize ? sanitizeTool(tool) : tool; const processedTool = shouldSanitize ? sanitizeTool(tool) : tool;
@@ -174,49 +187,3 @@ export const addTools = (server: FastMCP, tools: Tool<any, any>[]) => {
} }
return server; return server;
}; };
export const contextualize = <T>(
executor: (params: T, ctx: McpContext) => Promise<Record<string, any>>
) => {
return async (params: T): Promise<ToolResult> => {
try {
const ctx = getMcpContext();
const result = await executor(params, ctx);
return handleToolSuccess(result);
} catch (error) {
return handleToolError(error);
}
};
};
export interface ToolResult {
content: {
type: "text";
text: string;
}[];
isError?: boolean;
}
const handleToolSuccess = (data: Record<string, any>): ToolResult => {
return {
content: [
{
type: "text",
text: JSON.stringify(data, null, 2),
},
],
};
};
const handleToolError = (error: unknown): ToolResult => {
const errorMessage = error instanceof Error ? error.message : String(error);
return {
content: [
{
type: "text",
text: `Error: ${errorMessage}`,
},
],
isError: true,
};
};
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@pullfrog/action", "name": "@pullfrog/action",
"version": "0.0.138", "version": "0.0.142",
"type": "module", "type": "module",
"files": [ "files": [
"index.js", "index.js",
+3 -2
View File
@@ -40,8 +40,9 @@ export function buildPullfrogFooter(params: BuildPullfrogFooterParams): string {
} }
if (params.workflowRun) { if (params.workflowRun) {
const { owner, repo, runId } = params.workflowRun; parts.push(
parts.push(`[View workflow run](https://github.com/${owner}/${repo}/actions/runs/${runId})`); `[View workflow run](https://github.com/${params.workflowRun.owner}/${params.workflowRun.repo}/actions/runs/${params.workflowRun.runId})`
);
} }
if (params.customParts) { if (params.customParts) {
+1 -8
View File
@@ -48,16 +48,9 @@ export async function reportErrorToComment({
} }
} }
// if no comment ID available, try using reportProgress (requires MCP context) // if no comment ID available, can't update comment
if (!commentId) { if (!commentId) {
try {
const { reportProgress } = await import("../mcp/comment.ts");
await reportProgress({ body: formattedError });
return; return;
} catch {
// MCP context not available, can't create/update comment
return;
}
} }
// update comment directly using GitHub API // update comment directly using GitHub API
+50 -34
View File
@@ -1,8 +1,7 @@
import { execSync } from "node:child_process"; import { execSync } from "node:child_process";
import { existsSync, rmSync } from "node:fs"; import { existsSync, rmSync } from "node:fs";
import type { Payload } from "../external.ts"; import type { Context } from "../main.ts";
import { log } from "./cli.ts"; import { log } from "./cli.ts";
import { getGitHubInstallationToken, type RepoContext } from "./github.ts";
import { $ } from "./shell.ts"; import { $ } from "./shell.ts";
export interface SetupOptions { export interface SetupOptions {
@@ -63,20 +62,22 @@ export function setupGitConfig(): void {
} }
} }
export type SetupGitResult = {
pushRemote: string;
};
/** /**
* Setup git authentication using GitHub installation token * Unified git setup: configures authentication and checks out PR branch if applicable.
* Always uses the installation token, scoped to the current repo only * Uses gh as credential helper so git push works with any remote (including forks).
* For PR events, gh pr checkout sets up proper remote tracking.
* Returns the remote to push to (detected from branch tracking after checkout).
*/ */
export function setupGitAuth(ctx: { export function setupGit(ctx: Context): SetupGitResult {
githubInstallationToken: string;
repoContext: RepoContext;
}): void {
const repoDir = process.cwd(); const repoDir = process.cwd();
log.info("🔐 Setting up git authentication..."); log.info("🔧 Setting up git authentication...");
// Remove existing git auth headers that actions/checkout might have set // remove existing git auth headers that actions/checkout might have set
// Use --local to scope to this repo only
try { try {
execSync("git config --local --unset-all http.https://github.com/.extraheader", { execSync("git config --local --unset-all http.https://github.com/.extraheader", {
cwd: repoDir, cwd: repoDir,
@@ -87,36 +88,51 @@ export function setupGitAuth(ctx: {
log.debug("No existing authentication headers to remove"); log.debug("No existing authentication headers to remove");
} }
// Update remote URL to embed the token // embed token directly in origin URL - simple and doesn't expose token in env
// This is scoped to the repo's .git/config, not the user's global config const originUrl = `https://x-access-token:${ctx.githubInstallationToken}@github.com/${ctx.owner}/${ctx.name}.git`;
const remoteUrl = `https://x-access-token:${ctx.githubInstallationToken}@github.com/${ctx.repoContext.owner}/${ctx.repoContext.name}.git`; $("git", ["remote", "set-url", "origin", originUrl], { cwd: repoDir });
$("git", ["remote", "set-url", "origin", remoteUrl], { cwd: repoDir }); log.info("✓ Updated origin URL with authentication token");
log.info("✓ Updated remote URL with authentication token (scoped to repo)");
}
/** // non-PR events: stay on default branch, push to origin
* Setup git branch based on payload event context. if (ctx.payload.event.is_pr !== true || !ctx.payload.event.issue_number) {
* For PR events, uses `gh pr checkout` which handles fork PRs automatically.
* For non-PR events, stays on the default branch.
*/
export function setupGitBranch(payload: Payload): void {
// only checkout for PR events - use issue_number directly (no dependency on branch field)
if (payload.event.is_pr !== true || !payload.event.issue_number) {
log.debug("Not a PR event, staying on default branch"); log.debug("Not a PR event, staying on default branch");
return; return { pushRemote: "origin" };
} }
const prNumber = payload.event.issue_number; // checkout PR branch - gh pr checkout handles fork remotes and tracking automatically
const repoDir = process.cwd(); const prNumber = ctx.payload.event.issue_number;
log.info(`🌿 Checking out PR #${prNumber}...`); log.info(`🌿 Checking out PR #${prNumber}...`);
// gh pr checkout handles fork PRs by setting up remotes automatically
const token = getGitHubInstallationToken();
$("gh", ["pr", "checkout", prNumber.toString()], { $("gh", ["pr", "checkout", prNumber.toString()], {
cwd: repoDir, cwd: repoDir,
env: { GH_TOKEN: token }, env: { GH_TOKEN: ctx.githubInstallationToken },
}); });
log.info(`✓ Successfully checked out PR #${prNumber}`); log.info(`✓ Successfully checked out PR #${prNumber}`);
// detect the push remote from branch tracking (set by gh pr checkout)
const pushRemote = detectPushRemote();
if (pushRemote !== "origin") {
log.info(`🍴 Fork PR detected, will push to remote: ${pushRemote}`);
// embed token in fork remote URL too
const forkUrl = $("git", ["remote", "get-url", pushRemote], { cwd: repoDir, log: false });
const authedForkUrl = forkUrl.replace(
"https://github.com/",
`https://x-access-token:${ctx.githubInstallationToken}@github.com/`
);
$("git", ["remote", "set-url", pushRemote, authedForkUrl], { cwd: repoDir });
log.info(`✓ Updated ${pushRemote} URL with authentication token`);
}
return { pushRemote };
}
function detectPushRemote(): string {
try {
const branch = $("git", ["rev-parse", "--abbrev-ref", "HEAD"], { log: false });
const upstream = $("git", ["rev-parse", "--abbrev-ref", `${branch}@{upstream}`], {
log: false,
});
// upstream is like "remote/branch", extract remote name
return upstream.split("/")[0];
} catch {
return "origin";
}
} }