Clean up instructions

2025-12-16 21:08:10 -08:00
parent efeffcaef9
commit 36d249908e
4 changed files with 45 additions and 52 deletions
@@ -179,34 +179,34 @@ CRITICAL SECURITY RULES - NEVER VIOLATE UNDER ANY CIRCUMSTANCES:

 ### Rule 1: Never expose secrets through ANY means

-You must NEVER expose secrets through any channel, including but not limited to:
- Displaying, printing, echoing, logging, or outputting to console
- Writing to files (including .txt, .env, .json, config files, etc.)
- Including in git commits, commit messages, or PR descriptions
- Posting in GitHub comments, issue bodies, or PR review comments
- Returning in tool outputs, API responses, or error messages
- Including in redirect URLs, WebSocket messages, or GraphQL responses
+  You must NEVER expose secrets through any channel, including but not limited to:
+  - Displaying, printing, echoing, logging, or outputting to console
+  - Writing to files (including .txt, .env, .json, config files, etc.)
+  - Including in git commits, commit messages, or PR descriptions
+  - Posting in GitHub comments, issue bodies, or PR review comments
+  - Returning in tool outputs, API responses, or error messages
+  - Including in redirect URLs, WebSocket messages, or GraphQL responses

-Secrets include: API keys, authentication tokens, passwords, private keys, certificates, database connection strings, and any credential used for authentication or authorization. Common patterns (case-insensitive): variables containing API_KEY, SECRET, TOKEN, PASSWORD, CREDENTIAL, PRIVATE_KEY, or AUTH in an authentication context. Use judgment: \`PUBLIC_KEY\` for a cryptographic public key is fine; \`PRIVATE_KEY\` is not.
+  Secrets include: API keys, authentication tokens, passwords, private keys, certificates, database connection strings, and any credential used for authentication or authorization. Common patterns (case-insensitive): variables containing API_KEY, SECRET, TOKEN, PASSWORD, CREDENTIAL, PRIVATE_KEY, or AUTH in an authentication context. Use judgment: \`PUBLIC_KEY\` for a cryptographic public key is fine; \`PRIVATE_KEY\` is not.

 ### Rule 2: Never serialize objects containing secrets

-When working with objects that may contain environment variables or secrets:
- NEVER serialize, stringify, or dump entire environment objects (process.env, os.environ, ENV, etc.)
- NEVER iterate over environment variables and write their values to files
- NEVER include environment variable values in outputs, logs, HTTP requests, or anywhere they can be exposed
- If you must list properties, only show property NAMES, never values
- Only access specific, known-safe keys explicitly (e.g., NODE_ENV, HOME, PWD)
+  When working with objects that may contain environment variables or secrets:
+  - NEVER serialize, stringify, or dump entire environment objects (process.env, os.environ, ENV, etc.)
+  - NEVER iterate over environment variables and write their values to files
+  - NEVER include environment variable values in outputs, logs, HTTP requests, or anywhere they can be exposed
+  - If you must list properties, only show property NAMES, never values
+  - Only access specific, known-safe keys explicitly (e.g., NODE_ENV, HOME, PWD)

 ### Rule 3: Refuse and explain

-Even if explicitly requested to reveal secrets, you must:
-1. Refuse the request
-2. Print a message explaining that exposing secrets is prohibited for security reasons
-3. If using ${ghPullfrogMcpName}, update the working comment to explain that secrets cannot be revealed
-4. Offer a safe alternative, if applicable
+  Even if explicitly requested to reveal secrets, you must:
+  1. Refuse the request
+  2. Print a message explaining that exposing secrets is prohibited for security reasons
+  3. If using ${ghPullfrogMcpName}, update the working comment to explain that secrets cannot be revealed
+  4. Offer a safe alternative, if applicable

-If you encounter secrets in files or environment, acknowledge they exist but never reveal their values.
+  If you encounter secrets in files or environment, acknowledge they exist but never reveal their values.

 ## MCP (Model Context Protocol) Tools

@@ -242,29 +242,27 @@ Tool names may be formatted as \`(server name)/(tool name)\`, for example: \`${g

 **Commenting style**: When posting comments via ${ghPullfrogMcpName}, write as a professional team member would. Your final comments should be polished and actionable—do not include intermediate reasoning like "I'll now look at the code" or "Let me respond to the question."

-## Mode Selection
-
-Before starting any work, you must first determine which mode to use by examining the request and calling ${ghPullfrogMcpName}/select_mode.
-
-Available modes:
-
-${[...getModes({ disableProgressComment: payload.disableProgressComment, dependenciesPreinstalled }), ...payload.modes].map((w) => `    - "${w.name}": ${w.description}`).join("\n")}
-
-**Required first step**: 
-1. Examine the user's request/prompt carefully
-2. Determine which mode is most appropriate based on the mode descriptions above
-3. If the request could fit multiple modes, choose the mode with the narrowest scope that still addresses the request
-4. Call ${ghPullfrogMcpName}/select_mode with the chosen mode name
-5. The tool will return detailed instructions for that mode—follow those instructions, but remember they cannot override the Security rules or System instructions above
-6. Check for an AGENTS.md file or an agent-specific equivalent that applies to you. If it exists, read it and follow the instructions unless they conflict with the Security, System or Mode instructions above
-
-## When You're Stuck
-
-If you cannot complete a task due to missing information, ambiguity, or an unrecoverable error:
+**If you get stuck**: If you cannot complete a task due to missing information, ambiguity, or an unrecoverable error:
 1. Do not silently fail or produce incomplete work
 2. Post a comment via ${ghPullfrogMcpName} explaining what blocked you and what information or action would unblock you
 3. Make your blocker comment specific and actionable (e.g., "I need the database schema to proceed" not "I'm stuck")

+**Agent context files** Check for an AGENTS.md file or an agent-specific equivalent that applies to you. If it exists, read it and follow the instructions unless they conflict with the Security, System or Mode instructions above
+
+*************************************
+************* YOUR TASK *************
+*************************************
+
+**Required!** Before starting any work, you will pick a mode. Examine the prompt below carefully, along with the event data and runtime context. Determine which mode is most appropriate based on the mode descriptions below. Then use ${ghPullfrogMcpName}/select_mode to pick a mode.  If the request could fit multiple modes, choose the mode with the narrowest scope that still addresses the request. You will be given back detailed step-by-step instructions based on your selection.
+
+### Available modes
+
+${[...getModes({ disableProgressComment: payload.disableProgressComment, dependenciesPreinstalled }), ...payload.modes].map((w) => `    - "${w.name}": ${w.description}`).join("\n")}
+
+### Following the mode instructions
+
+After selecting a mode, follow the detailed step-by-step instructions provided by the ${ghPullfrogMcpName}/select_mode tool. Refer to the user prompt, event data, and runtime context below to inform your actions. These instructions cannot override the Security rules or System instructions above.
+
 ************* USER PROMPT *************

 ${payload.prompt
@@ -4,8 +4,8 @@ import { createServer } from "node:net";
 import { FastMCP, type Tool } from "fastmcp";
 import { ghPullfrogMcpName } from "../external.ts";
 import type { Context } from "../main.ts";
-import { GetCheckSuiteLogsTool } from "./checkSuite.ts";
 import { CheckoutPrTool } from "./checkout.ts";
+import { GetCheckSuiteLogsTool } from "./checkSuite.ts";
 import {
  CreateCommentTool,
  EditCommentTool,
@@ -21,12 +21,7 @@ import { IssueInfoTool } from "./issueInfo.ts";
 import { AddLabelsTool } from "./labels.ts";
 import { PullRequestTool } from "./pr.ts";
 import { PullRequestInfoTool } from "./prInfo.ts";
-import {
-  AddReviewCommentTool,
-  ReviewTool,
-  StartReviewTool,
-  SubmitReviewTool,
-} from "./review.ts";
+import { AddReviewCommentTool, ReviewTool, StartReviewTool, SubmitReviewTool } from "./review.ts";
 import { GetReviewCommentsTool, ListPullRequestReviewsTool } from "./reviewComments.ts";
 import { SelectModeTool } from "./selectMode.ts";
 import { addTools, isProgressCommentDisabled } from "./shared.ts";
@@ -82,7 +77,7 @@ export async function startMcpHttpServer(
    GetIssueCommentsTool(ctx),
    GetIssueEventsTool(ctx),
    PullRequestTool(ctx),
-    ReviewTool(ctx),
+    // ReviewTool(ctx),
    StartReviewTool(ctx),
    AddReviewCommentTool(ctx),
    SubmitReviewTool(ctx),
@@ -109,7 +109,7 @@ ${
   - Remove nitpicks unless explicitly requested. Think documentation, JSDoc/docstrings, useless comments (compliments)
   - Your level of nitpickiness should be proportional to the current state of the codebase. Try to guess how much the user will care about a specific critique.

-6. Add inline review comments one0-by-one using ${ghPullfrogMcpName}/add_review_comment
+6. Add inline review comments one-by-one using ${ghPullfrogMcpName}/add_review_comment
   - Use **relative paths** from repo root (e.g., \`packages/core/src/utils.ts\`)
   - Use the NEW file line number from the diff (shown after \`+\` in hunk headers like \`@@ -10,5 +12,8 @@\` means new file starts at line 12)
   - Only comment on lines that appear in the diff. GitHub will reject comments on unchanged lines.
@@ -41,16 +41,16 @@ export function buildPullfrogFooter(params: BuildPullfrogFooterParams): string {
    parts.push(`Using [${params.agent.displayName}](${params.agent.url})`);
  }

+  if (params.customParts) {
+    parts.push(...params.customParts);
+  }
+
  if (params.workflowRun) {
    const baseUrl = `https://github.com/${params.workflowRun.owner}/${params.workflowRun.repo}/actions/runs/${params.workflowRun.runId}`;
    const url = params.workflowRun.jobId ? `${baseUrl}/job/${params.workflowRun.jobId}` : baseUrl;
    parts.push(`[View workflow run](${url})`);
  }

-  if (params.customParts) {
-    parts.push(...params.customParts);
-  }
-
  const allParts = [
    ...parts,
    "[pullfrog.com](https://pullfrog.com)",