@lincoln504/pi-research 1.3.12 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cli.mjs +5495 -4645
- package/dist/prompts/research-tool-usage.md +1 -1
- package/dist/prompts/researcher.md +1 -0
- package/dist/prompts/system-lead-router.md +122 -0
- package/dist/prompts/system-lead-synthesizer.md +46 -0
- package/dist/thread-worker.mjs +94 -19
- package/docs/ARCHITECTURE.md +18 -10
- package/docs/CHANGELOG.md +149 -0
- package/docs/CONFIGURATION.md +106 -7
- package/package.json +2 -2
- package/scripts/build.cjs +8 -1
- package/skills/pi-research/SKILL.md +1 -1
- package/src/cli.ts +5 -1
- package/src/config.ts +12 -8
- package/src/constants.ts +1 -1
- package/src/core/interfaces/observer-interfaces.ts +3 -3
- package/src/core/interfaces/orchestration-interfaces.ts +2 -0
- package/src/core/interfaces/planning-interfaces.ts +7 -1
- package/src/core/interfaces/scheduler-interfaces.ts +18 -2
- package/src/core/llm/agentic-repair.ts +7 -2
- package/src/core/llm/inject-date.ts +4 -1
- package/src/core/llm/llm-utils.ts +7 -0
- package/src/core/planning-service.ts +719 -91
- package/src/core/planning-utils.ts +21 -5
- package/src/core/service-initialization.ts +19 -3
- package/src/healthcheck/index.ts +11 -2
- package/src/index.ts +4 -3
- package/src/infrastructure/browser/browser-client.ts +68 -34
- package/src/infrastructure/browser/browser-task-scheduler.ts +220 -34
- package/src/infrastructure/browser/config.ts +41 -1
- package/src/infrastructure/browser/priority-task-queue.ts +55 -1
- package/src/infrastructure/browser/scheduler-factory.ts +12 -1
- package/src/infrastructure/browser/task-execution-service.ts +5 -5
- package/src/infrastructure/browser/thread-worker-browser.ts +32 -2
- package/src/infrastructure/browser/thread-worker-messaging.ts +38 -6
- package/src/infrastructure/browser/thread-worker.mjs +94 -19
- package/src/infrastructure/browser/thread-worker.ts +2 -2
- package/src/infrastructure/browser/worker-pool-manager.ts +127 -12
- package/src/infrastructure/embedding/embedding-client.ts +14 -4
- package/src/infrastructure/embedding/embedding-factory.ts +83 -15
- package/src/infrastructure/file-lock-service.ts +214 -19
- package/src/infrastructure/knowledge-store-service.ts +14 -0
- package/src/infrastructure/research-run-semaphore.ts +1 -1
- package/src/infrastructure/service-initialization.ts +7 -0
- package/src/knowledge/embedder-init.ts +43 -17
- package/src/logger.ts +11 -0
- package/src/orchestration/deep-research-orchestrator.ts +141 -87
- package/src/orchestration/quick-research-orchestrator.ts +11 -2
- package/src/orchestration/research-orchestration-service.ts +8 -0
- package/src/orchestration/research-synthesis-service.ts +53 -1
- package/src/orchestration/researcher-executor.ts +53 -2
- package/src/orchestration/researcher.ts +15 -2
- package/src/prompts/research-tool-usage.md +1 -1
- package/src/prompts/researcher.md +1 -0
- package/src/prompts/system-lead-router.md +122 -0
- package/src/prompts/system-lead-synthesizer.md +46 -0
- package/src/tools/research-knowledge-search.ts +11 -3
- package/src/tools/scrape.ts +6 -0
- package/src/tools/search.ts +7 -0
- package/src/tools/security.ts +27 -9
- package/src/tools/stackexchange.ts +13 -7
- package/src/tools/youtube-transcript.ts +26 -12
- package/src/utils/cancellation.ts +36 -0
- package/src/utils/coverage-digest.ts +204 -0
- package/src/utils/llm-usage.ts +33 -6
- package/src/utils/metrics-summary.ts +20 -4
- package/src/utils/metrics.ts +27 -1
- package/src/web-research/browser-search.ts +93 -20
- package/dist/prompts/system-lead-evaluator.md +0 -118
- package/src/prompts/system-lead-evaluator.md +0 -118
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Research Lead — Routing
|
|
2
|
+
|
|
3
|
+
You decide whether this research run continues or ends.
|
|
4
|
+
|
|
5
|
+
You are given the message in two parts.
|
|
6
|
+
|
|
7
|
+
**NEW SINCE YOUR LAST DECISION** holds the **full reports** from the researchers that have just finished. This is the evidence your decision turns on — read it. Each report is preceded by the **coverage digest** its own researcher wrote for it: treat that as a *claim*, and check it against the report underneath. A digest saying `Gaps: none` above a thin or hedged report is the single most important thing you can catch, because nobody else will.
|
|
8
|
+
|
|
9
|
+
**REVIEWED IN EARLIER ROUNDS** holds only the coverage digests of reports you already read in full on a previous round and already judged. They are not repeated in full — you have seen them.
|
|
10
|
+
|
|
11
|
+
Everything specific to this run — the root query, the current round and round budget, the agenda so far, the queries already executed, any additional user guidance, and the phase guidance for this particular round — is supplied in a **RUN CONTEXT** block at the END of the message you are given, after the reports. Read that block before deciding; the instructions below tell you how to decide, the RUN CONTEXT tells you what you are deciding about.
|
|
12
|
+
|
|
13
|
+
You never write the report. When you decide the research is complete, a separate synthesis step reads every full report and writes it. Your output is a decision, not prose.
|
|
14
|
+
|
|
15
|
+
## CRITICAL: Steering Compliance Checkpoint
|
|
16
|
+
- **STRICT STEERING**: If the RUN CONTEXT block carries an "ADDITIONAL USER GUIDANCE" section, you MUST treat every point in it as a **mandatory rule and instruction** for your decisions, next round goals, and queries. Do not ignore them. They are directional requirements.
|
|
17
|
+
- **STEERING SATISFACTION**: Before deciding to FINISH, you MUST explicitly verify that ALL user steering requirements are actually covered by the findings — not merely claimed by a digest. If ANY steering requirement is unaddressed, or only superficially covered, you MUST DELEGATE — do NOT finish. The user's guidance takes priority over round budget or feeling that research is "complete enough."
|
|
18
|
+
|
|
19
|
+
{{disabled_tools_section}}
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Complexity-Aware Decision Thresholds
|
|
24
|
+
|
|
25
|
+
**Complexity Level**: {{complexity_label}}
|
|
26
|
+
|
|
27
|
+
{{complexity_guidance}}
|
|
28
|
+
|
|
29
|
+
The phase guidance for the current round appears in the RUN CONTEXT block; it refines these thresholds for where this run currently sits in its round budget.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Reading the evidence
|
|
34
|
+
|
|
35
|
+
For **earlier rounds** you have only the digest, and you already judged that work when it arrived. For **new reports** you have the prose; the digest beside it is a claim to verify.
|
|
36
|
+
|
|
37
|
+
Read a digest as follows:
|
|
38
|
+
|
|
39
|
+
- **`Covered`** tells you what is established. Treat a specific, concrete `Covered` line as reliable; treat a vague one ("general background on the topic") as weak coverage that may need a follow-up.
|
|
40
|
+
- **`Gaps`** is a researcher telling you directly what it could not reach. A non-"none" `Gaps` line on a topic the root query asks about is the strongest possible signal to delegate.
|
|
41
|
+
- **`Unsubstantiated`** flags claims that were looked for and not grounded. Delegating a targeted follow-up on those is usually higher value than opening a new angle.
|
|
42
|
+
- **`Sources: 0` or a very low count** means that researcher produced little usable material regardless of what its other lines claim. Re-cover that goal.
|
|
43
|
+
- **A digest that says coverage is unknown** was derived mechanically because that researcher emitted no digest of its own. For a new report that costs you nothing — read the report. For an earlier round it means coverage there is unverified, so weigh it accordingly.
|
|
44
|
+
|
|
45
|
+
**Verify the new reports rather than trusting their digests.** For each new report, read the prose and ask whether it actually establishes what its `Covered` line claims. Specific, sourced prose backs the claim up. Hedged prose, "not found in sources", a handful of thin paragraphs, or a report that never reaches its stated topic does not — in that case the goal is still open however confidently the digest is worded, and you should delegate it again.
|
|
46
|
+
|
|
47
|
+
Then compare everything covered — earlier digests plus what the new reports actually establish — against the root query and the initial agenda. What the root query asks for and nothing covers is a gap.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Decision Framework
|
|
52
|
+
|
|
53
|
+
**FINISH if:** Coverage across the new reports and the earlier digests meets the complexity-specific synthesis criteria above. ("Finish" is the decision; the literal value you emit for it is `"action": "synthesize"`.)
|
|
54
|
+
**DELEGATE if:** Coverage meets the complexity-specific delegation criteria above.
|
|
55
|
+
**Note on Guidance**: If the user provides additional guidance mid-research (via Alt+Enter or direct follow-up), those messages will be provided to you. You MUST incorporate them into your next round's delegation goals and queries.
|
|
56
|
+
|
|
57
|
+
**STAY IN SCOPE (every delegation):**
|
|
58
|
+
- Going deeper on in-scope material is always welcome. Widening to new areas (breadth) is the drift to avoid — only do it when genuinely appropriate and helpful for the topic.
|
|
59
|
+
- A gap is missing depth on what was asked — not a broader topic next to it. Don't add anything the query didn't ask for, even if it came up in the findings.
|
|
60
|
+
- Match the query's scope-bounding constraints exactly — don't broaden them, don't narrow them.
|
|
61
|
+
|
|
62
|
+
**COMMON MISTAKES TO AVOID:**
|
|
63
|
+
- Do NOT finish early just because you've done "enough" rounds. Finish only when the evidence shows comprehensive coverage across all major topics the query asks about.
|
|
64
|
+
- Do NOT finish with gaps remaining, hoping they can be "filled in later". Complete the research first.
|
|
65
|
+
- Do NOT invent a gap outside the query's scope just to keep going or fill the budget. Finish what was asked; don't add what wasn't.
|
|
66
|
+
- Do NOT write findings, prose, or a report. You have read findings, but writing the report is a separate step's job. A `reason` is one sentence.
|
|
67
|
+
|
|
68
|
+
Use unique, targeted queries for any new researchers.
|
|
69
|
+
|
|
70
|
+
**Decision**: Return valid JSON in a code block:
|
|
71
|
+
|
|
72
|
+
**If the research is complete**:
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"action": "synthesize",
|
|
76
|
+
"reason": "<one sentence naming the coverage that makes this complete>"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**If delegating**:
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"action": "delegate",
|
|
84
|
+
"researchers": [
|
|
85
|
+
{
|
|
86
|
+
"id": "<CURRENT_ROUND>.1",
|
|
87
|
+
"name": "<Researcher Specialty>",
|
|
88
|
+
"goal": "<Focused gap or new angle to investigate>",
|
|
89
|
+
"queries": ["<query_1>", "<query_2>", "<query_3>", "..."]
|
|
90
|
+
}
|
|
91
|
+
],
|
|
92
|
+
"allQueries": ["<flat_list_of_all_queries_from_all_new_researchers>"]
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**DELEGATION REQUIREMENTS**:
|
|
97
|
+
- **CRITICAL — Queries are mandatory**: Every researcher MUST have at least one query. Never plan a researcher without queries. Researchers receive ONLY the search results you delegate to them.
|
|
98
|
+
- **Maximize queries**: For EACH researcher, generate the maximum number of targeted, specific queries within the budget. Do not plan fewer than needed — fill the budget. Queries should target primary sources and authoritative evidence.
|
|
99
|
+
- **YouTube discovery**: For roughly one in {{youtube_query_every_n}} queries, append the word `youtube` to the query text (e.g. `"<topic> analysis youtube"`). DuckDuckGo rarely surfaces YouTube on its own, and YouTube links let researchers read video transcripts. Skip only when the gap is clearly unsuited to video.
|
|
100
|
+
- **Temporal anchoring**: Anchor every new time-sensitive query to the current month and year shown at the top of this prompt. Use that exact year (and month where relevant); never default to an older year than the one shown there unless the user explicitly asks about the past.
|
|
101
|
+
- **Flexible coverage**: Use up to {{max_team_size}} researchers to cover distinct angles in parallel. Scale based on research gaps — a single well-targeted researcher is often sufficient for focused gaps.
|
|
102
|
+
- **Source diversity**: Encourage researchers to find multiple authoritative sources per topic area to enable comprehensive citations in the final synthesis.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Quality Standards for Delegation
|
|
107
|
+
|
|
108
|
+
When delegating, ensure:
|
|
109
|
+
- **Query Specificity**: Each new query targets distinct, unexplored territory
|
|
110
|
+
- **No Redundancy**: Do not repeat queries from previous rounds
|
|
111
|
+
- **Specialized Focus**: Each new researcher has a clear, distinct angle
|
|
112
|
+
- **Gap-Driven**: Only delegate when the evidence shows a gap that existing coverage cannot resolve
|
|
113
|
+
- **Progressive Depth**: New queries go deeper, or to a new angle still inside the query's scope — never outside it, and never repeating surface-level coverage
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Output Requirements
|
|
118
|
+
|
|
119
|
+
- **Researcher IDs**: Use Round.Index format — the current round number from the RUN CONTEXT block, then the researcher index. In round 3 that is **3.1**, **3.2**, and so on.
|
|
120
|
+
- **Query Budget**: Use the complexity-specific budget ({{query_budget}} per researcher). Fill each researcher's query budget completely.
|
|
121
|
+
- **Team Size**: Scale researcher count to match the gaps. Use up to {{max_team_size}} researchers when delegating, but a single well-targeted researcher is often sufficient for focused gaps. Don't pad the team when fewer researchers will cover the remaining gaps efficiently.
|
|
122
|
+
- **Format**: ONLY return valid JSON in a code block. Never return report prose.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Research Lead — Synthesis
|
|
2
|
+
|
|
3
|
+
You write the final report for this research run.
|
|
4
|
+
|
|
5
|
+
The research is finished. Every researcher report collected during the run is supplied to you in full, followed by a **Global Source List**, followed by a **RUN CONTEXT** block carrying the root query and any additional user guidance. Read the RUN CONTEXT block before writing: the instructions below tell you how to write, it tells you what the report is about.
|
|
6
|
+
|
|
7
|
+
You do not decide anything and you do not plan further research. Your only output is the report.
|
|
8
|
+
|
|
9
|
+
## CRITICAL: Steering Compliance
|
|
10
|
+
If the RUN CONTEXT block carries an "ADDITIONAL USER GUIDANCE" section, treat every point in it as a **mandatory rule** governing the report's content, structure, and emphasis. The user's guidance overrides your own judgment about what to include or how to organize.
|
|
11
|
+
|
|
12
|
+
{{disabled_tools_section}}
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Synthesis Protocol
|
|
17
|
+
|
|
18
|
+
1. **Organization**: Organize the report logically **BY TOPIC**. Do NOT structure it by researcher or round.
|
|
19
|
+
2. **Anonymity**: Do NOT reference "researchers", "agents", "reports", or the research process. Present the findings as a direct, unified knowledge base.
|
|
20
|
+
3. **Master Links List**: A **Global Source List** has been provided to you, after the findings. Use these sequential numbers [1], [2], [3], etc., for all inline citations. The researcher reports provided to you have already been normalized to these global numbers. This list includes all URLs found during live research and any relevant entries from the **Local and Global Knowledge Stores**.
|
|
21
|
+
4. **Exhaustive Synthesis**: Use ALL findings from ALL reports. Include every fact, date, name, and statistic verbatim. Longer is better.
|
|
22
|
+
5. **Strict Grounding**: Every sentence must come from a report. Use [N] inline citations. No prior knowledge.
|
|
23
|
+
6. **CRITICAL — Links at Bottom Only**:
|
|
24
|
+
- Write all topic sections first with inline citations [1], [2], etc., using the numbers from the **Global Source List**.
|
|
25
|
+
- Place exactly ONE `CITED LINKS` section at the VERY END of the entire synthesis.
|
|
26
|
+
- This section must contain the complete master list of all unique URLs exactly as provided in the **Global Source List**.
|
|
27
|
+
- Do NOT include any links within topic sections or subsections.
|
|
28
|
+
- Format: `[1] https://url.com [Source: ...] — brief description` on each line.
|
|
29
|
+
|
|
30
|
+
> **MANDATORY TERMINATION RULE**: Your synthesis is not complete until it ends with `CITED LINKS`. Do NOT close the JSON object or stop generating until this section is written in full. A synthesis without `CITED LINKS` is a failed output.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Output Requirements
|
|
35
|
+
|
|
36
|
+
- **Synthesis Quality**: Logical topic-based structure in plain prose, maximal detail, NO mention of researchers, NO markdown headings or bullets.
|
|
37
|
+
- **Format**: ONLY return valid JSON in a code block:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"action": "synthesize",
|
|
42
|
+
"content": "<Plain prose report with [N] citations, organized by topic. No markdown headings, bullets, or bold text. Followed by the mandatory CITED LINKS section.>"
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
{{partial_synthesis_section}}
|
|
@@ -54,6 +54,7 @@ import { loadPrompt } from '../core/llm/prompts.ts';
|
|
|
54
54
|
import { formatParentContext } from '../orchestration/session-context.ts';
|
|
55
55
|
import { getConfig, type ConfigInterface, type Config } from '../config.ts';
|
|
56
56
|
import { createKnowledgeSearchPanel } from '../tui/knowledge-search-panel.ts';
|
|
57
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
57
58
|
|
|
58
59
|
// ---------------------------------------------------------------------------
|
|
59
60
|
// Phase 1: Tool Parameters
|
|
@@ -439,6 +440,7 @@ export async function runBackgroundExtraction(
|
|
|
439
440
|
maxTokens: number,
|
|
440
441
|
thinkingLevel: Config['LLM_THINKING_LEVEL'],
|
|
441
442
|
signal?: AbortSignal,
|
|
443
|
+
sessionId?: string,
|
|
442
444
|
): Promise<ResearchKnowledgeSynthesisResponse> {
|
|
443
445
|
const promptTemplate = loadPrompt('research-knowledge-search-extractor');
|
|
444
446
|
if (!promptTemplate) {
|
|
@@ -479,7 +481,8 @@ export async function runBackgroundExtraction(
|
|
|
479
481
|
}, buildSafeOptions(model, {
|
|
480
482
|
apiKey: auth.apiKey,
|
|
481
483
|
headers: auth.headers,
|
|
482
|
-
signal
|
|
484
|
+
signal,
|
|
485
|
+
sessionId,
|
|
483
486
|
}, maxTokens, thinkingLevel)),
|
|
484
487
|
llmTimeout,
|
|
485
488
|
'knowledge-search-extraction',
|
|
@@ -537,6 +540,7 @@ export async function runBackgroundExtraction(
|
|
|
537
540
|
context: 'Knowledge search extraction — synthesizing answer from reference documents',
|
|
538
541
|
serviceName: 'ResearchKnowledgeSearch',
|
|
539
542
|
signal,
|
|
543
|
+
sessionId,
|
|
540
544
|
// Match the budget of the call being repaired so a large synthesis is not re-truncated
|
|
541
545
|
// at repairJsonWithLlm's smaller default (16384). Mirrors the planning-service repairs.
|
|
542
546
|
maxTokens,
|
|
@@ -972,6 +976,11 @@ export function createResearchKnowledgeSearchTool(iface?: ConfigInterface): Tool
|
|
|
972
976
|
config.SYNTHESIS_MAX_TOKENS,
|
|
973
977
|
config.LLM_THINKING_LEVEL,
|
|
974
978
|
signal,
|
|
979
|
+
// Cache/session-affinity hint only (keeps repeated calls on the same warmed
|
|
980
|
+
// replica) — same resolution research-config.ts uses, since this tool has no
|
|
981
|
+
// researchId of its own to key on. ctx.sessionId is read defensively: it is
|
|
982
|
+
// not on every host's ExtensionContext shape, hence the `as any`.
|
|
983
|
+
(ctx as any).sessionId || ctx.sessionManager?.getSessionId(),
|
|
975
984
|
);
|
|
976
985
|
|
|
977
986
|
const durationMs = Date.now() - startTime;
|
|
@@ -983,7 +992,6 @@ export function createResearchKnowledgeSearchTool(iface?: ConfigInterface): Tool
|
|
|
983
992
|
return buildSteeringResult(result, urls);
|
|
984
993
|
} catch (error) {
|
|
985
994
|
const durationMs = Date.now() - startTime;
|
|
986
|
-
const msg = error instanceof Error ? error.message : String(error);
|
|
987
995
|
|
|
988
996
|
// A CANCELLED search is not an empty store. Reporting the miss string here
|
|
989
997
|
// told the calling agent, definitively, that the knowledge store has
|
|
@@ -991,7 +999,7 @@ export function createResearchKnowledgeSearchTool(iface?: ConfigInterface): Tool
|
|
|
991
999
|
// the very work the user just interrupted. Propagate the abort instead;
|
|
992
1000
|
// the run is ending either way. (Same misclassification as the search
|
|
993
1001
|
// layer's "browser workers may be unavailable" on Ctrl-C.)
|
|
994
|
-
if (
|
|
1002
|
+
if (isCancellation(error, signal)) {
|
|
995
1003
|
metrics.observe('research_knowledge_search_duration_ms', durationMs, { status: 'cancelled' });
|
|
996
1004
|
metrics.increment('research_knowledge_search_total', 1, { status: 'cancelled' });
|
|
997
1005
|
logger.debug('[research-knowledge-search] Cancelled mid-search — propagating rather than reporting an empty store.');
|
package/src/tools/scrape.ts
CHANGED
|
@@ -31,6 +31,7 @@ import { ServiceNames } from '../core/service-interfaces.ts';
|
|
|
31
31
|
import type { IKnowledgeStoreService } from '../core/service-interfaces.ts';
|
|
32
32
|
import { logger } from '../logger.ts';
|
|
33
33
|
import { metrics } from '../utils/metrics.ts';
|
|
34
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
34
35
|
|
|
35
36
|
export function createScrapeTool(options: {
|
|
36
37
|
ctx: ExtensionContext;
|
|
@@ -267,6 +268,11 @@ export function createScrapeTool(options: {
|
|
|
267
268
|
}, container);
|
|
268
269
|
freshResults = Array.isArray(results) ? results : [];
|
|
269
270
|
} catch (error) {
|
|
271
|
+
// A cancelled scrape is not a failed scrape — see isCancellation.
|
|
272
|
+
if (isCancellation(error, signal)) {
|
|
273
|
+
metrics.increment('tool_scrape_calls_total', 1, { status: 'cancelled' });
|
|
274
|
+
throw error;
|
|
275
|
+
}
|
|
270
276
|
const message = error instanceof Error ? error.message : String(error);
|
|
271
277
|
logger.error(`[scrape tool] Scrape failed: ${message}`);
|
|
272
278
|
metrics.increment('tool_scrape_calls_total', 1, { status: 'error' });
|
package/src/tools/search.ts
CHANGED
|
@@ -13,6 +13,7 @@ import type { SystemResearchState } from '../orchestration/deep-research-types.t
|
|
|
13
13
|
import { logger } from '../logger.ts';
|
|
14
14
|
import { type Config, getConfig } from '../config.ts';
|
|
15
15
|
import { metrics } from '../utils/metrics.ts';
|
|
16
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
16
17
|
import { tryGetServiceContainerFromCtx } from '../core/service-registry.ts';
|
|
17
18
|
|
|
18
19
|
export function createSearchTool(options: {
|
|
@@ -134,6 +135,12 @@ export function createSearchTool(options: {
|
|
|
134
135
|
};
|
|
135
136
|
} catch (error) {
|
|
136
137
|
const elapsed = Date.now() - startTime;
|
|
138
|
+
// A cancelled search is not a failed search — see isCancellation.
|
|
139
|
+
if (isCancellation(error, signal)) {
|
|
140
|
+
metrics.observe('tool_search_duration_ms', elapsed, { status: 'cancelled' });
|
|
141
|
+
metrics.increment('tool_search_calls_total', 1, { status: 'cancelled' });
|
|
142
|
+
throw error;
|
|
143
|
+
}
|
|
137
144
|
metrics.observe('tool_search_duration_ms', elapsed, { status: 'error' });
|
|
138
145
|
metrics.increment('tool_search_calls_total', 1, { status: 'error' });
|
|
139
146
|
const msg = error instanceof Error ? error.message : String(error);
|
package/src/tools/security.ts
CHANGED
|
@@ -11,6 +11,7 @@ import { searchSecurityDatabases } from '../security/index.ts';
|
|
|
11
11
|
import type { ToolUsageTracker } from '../utils/tool-usage-tracker.ts';
|
|
12
12
|
import { getMaxGatheringCalls } from '../constants.ts';
|
|
13
13
|
import { metrics } from '../utils/metrics.ts';
|
|
14
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
14
15
|
import type { SecuritySearchParams } from '../security/types.ts';
|
|
15
16
|
|
|
16
17
|
const MAX_DESCRIPTION_CHARS = 300;
|
|
@@ -78,7 +79,24 @@ export function createSecuritySearchTool(options: {
|
|
|
78
79
|
_extensionCtx,
|
|
79
80
|
): Promise<AgentToolResult<unknown>> {
|
|
80
81
|
const startTime = Date.now();
|
|
81
|
-
|
|
82
|
+
|
|
83
|
+
// Every exit path below increments `tool_security_search_calls_total` itself
|
|
84
|
+
// (labeled with its own status) — there is no separate unconditional increment
|
|
85
|
+
// here. There used to be one, which double-counted every single call: sumCounter
|
|
86
|
+
// matches both the bare key and every labeled variant of the same base name, so
|
|
87
|
+
// the Session Metrics / Research Summary view reported exactly 2x the real count.
|
|
88
|
+
|
|
89
|
+
// Validate BEFORE spending the budget: a rejected call did no work, and charging
|
|
90
|
+
// it against the shared MAX_GATHERING_CALLS allowance turns a malformed call into
|
|
91
|
+
// a permanently lost one. See youtube-transcript for the sharpest case (a single
|
|
92
|
+
// allowed call, forfeited by a schema violation).
|
|
93
|
+
if (!Value.Check(SecuritySearchParamsSchema, params)) {
|
|
94
|
+
metrics.increment('tool_security_search_calls_total', 1, { status: 'invalid_params' });
|
|
95
|
+
return {
|
|
96
|
+
content: [{ type: 'text', text: 'Invalid parameters for security_search tool.' }],
|
|
97
|
+
details: { error: 'invalid_parameters' },
|
|
98
|
+
};
|
|
99
|
+
}
|
|
82
100
|
|
|
83
101
|
// Record call in tracker - returns false if limit reached
|
|
84
102
|
const allowed = options.tracker.recordCall('security_search');
|
|
@@ -90,14 +108,6 @@ export function createSecuritySearchTool(options: {
|
|
|
90
108
|
};
|
|
91
109
|
}
|
|
92
110
|
|
|
93
|
-
if (!Value.Check(SecuritySearchParamsSchema, params)) {
|
|
94
|
-
metrics.increment('tool_security_search_calls_total', 1, { status: 'invalid_params' });
|
|
95
|
-
return {
|
|
96
|
-
content: [{ type: 'text', text: 'Invalid parameters for security_search tool.' }],
|
|
97
|
-
details: { error: 'invalid_parameters' },
|
|
98
|
-
};
|
|
99
|
-
}
|
|
100
|
-
|
|
101
111
|
const p = params as SecuritySearchParamsType;
|
|
102
112
|
|
|
103
113
|
const terms = p.terms;
|
|
@@ -167,6 +177,14 @@ export function createSecuritySearchTool(options: {
|
|
|
167
177
|
results = await searchSecurityDatabases(searchParams, signal);
|
|
168
178
|
} catch (error) {
|
|
169
179
|
const duration = Date.now() - startTime;
|
|
180
|
+
// A cancelled search is not a database outage — see isCancellation. The
|
|
181
|
+
// "temporary issue - try again later" text below invites exactly the retry
|
|
182
|
+
// the user just interrupted.
|
|
183
|
+
if (isCancellation(error, signal)) {
|
|
184
|
+
metrics.observe('tool_security_search_duration_ms', duration, { status: 'cancelled' });
|
|
185
|
+
metrics.increment('tool_security_search_calls_total', 1, { status: 'cancelled' });
|
|
186
|
+
throw error;
|
|
187
|
+
}
|
|
170
188
|
metrics.observe('tool_security_search_duration_ms', duration, { status: 'error' });
|
|
171
189
|
metrics.increment('tool_security_search_calls_total', 1, { status: 'error' });
|
|
172
190
|
const errorMsg = error instanceof Error ? error.message : String(error);
|
|
@@ -10,6 +10,7 @@ import { Value } from 'typebox/value';
|
|
|
10
10
|
import { stackexchangeCommand } from '../stackexchange/index.ts';
|
|
11
11
|
import type { ToolUsageTracker } from '../utils/tool-usage-tracker.ts';
|
|
12
12
|
import { getMaxGatheringCalls } from '../constants.ts';
|
|
13
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
13
14
|
|
|
14
15
|
export function createStackexchangeTool(options: {
|
|
15
16
|
ctx: ExtensionContext;
|
|
@@ -74,6 +75,15 @@ export function createStackexchangeTool(options: {
|
|
|
74
75
|
_onUpdate,
|
|
75
76
|
extensionCtx,
|
|
76
77
|
): Promise<AgentToolResult<unknown>> {
|
|
78
|
+
// Validate BEFORE spending the budget — see security.ts. A rejected call did no
|
|
79
|
+
// work and must not consume one of MAX_GATHERING_CALLS.
|
|
80
|
+
if (!Value.Check(StackExchangeParamsSchema, params)) {
|
|
81
|
+
return {
|
|
82
|
+
content: [{ type: 'text', text: 'Invalid parameters for stackexchange tool.' }],
|
|
83
|
+
details: { error: 'invalid_parameters' },
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
77
87
|
// Record call in tracker - returns false if limit reached
|
|
78
88
|
const allowed = tracker.recordCall('stackexchange');
|
|
79
89
|
if (!allowed) {
|
|
@@ -83,13 +93,6 @@ export function createStackexchangeTool(options: {
|
|
|
83
93
|
};
|
|
84
94
|
}
|
|
85
95
|
|
|
86
|
-
if (!Value.Check(StackExchangeParamsSchema, params)) {
|
|
87
|
-
return {
|
|
88
|
-
content: [{ type: 'text', text: 'Invalid parameters for stackexchange tool.' }],
|
|
89
|
-
details: { error: 'invalid_parameters' },
|
|
90
|
-
};
|
|
91
|
-
}
|
|
92
|
-
|
|
93
96
|
const p = params as StackExchangeParams;
|
|
94
97
|
const command = p.command;
|
|
95
98
|
|
|
@@ -105,6 +108,9 @@ export function createStackexchangeTool(options: {
|
|
|
105
108
|
signal,
|
|
106
109
|
});
|
|
107
110
|
} catch (error) {
|
|
111
|
+
// A cancelled query was never rate-limited — see isCancellation. Naming a
|
|
112
|
+
// quota the run never hit is a cause the agent can carry into its report.
|
|
113
|
+
if (isCancellation(error, signal)) throw error;
|
|
108
114
|
const errorMsg = error instanceof Error ? error.message : String(error);
|
|
109
115
|
return {
|
|
110
116
|
content: [
|
|
@@ -24,6 +24,7 @@ import { cacheScrapedContent, registerScrapedLinks, registerTranscribedLinks, re
|
|
|
24
24
|
import { type Config, getConfig } from '../config.ts';
|
|
25
25
|
import { logger } from '../logger.ts';
|
|
26
26
|
import { metrics } from '../utils/metrics.ts';
|
|
27
|
+
import { isCancellation } from '../utils/cancellation.ts';
|
|
27
28
|
|
|
28
29
|
export function createYoutubeTranscriptTool(options: {
|
|
29
30
|
ctx: ExtensionContext;
|
|
@@ -75,18 +76,12 @@ export function createYoutubeTranscriptTool(options: {
|
|
|
75
76
|
_onUpdate: AgentToolUpdateCallback<unknown>,
|
|
76
77
|
extensionCtx: ExtensionContext,
|
|
77
78
|
): Promise<AgentToolResult<unknown>> {
|
|
78
|
-
//
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
content: [{ type: 'text', text: tracker.getLimitMessage('youtube_transcript') }],
|
|
85
|
-
details: { blocked: true, reason: 'limit_reached' },
|
|
86
|
-
};
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
|
|
79
|
+
// Validate BEFORE spending the budget. Charging a rejected call is not a rate
|
|
80
|
+
// limit, it is a forfeit: this tool's schema caps `urls` at maxVideos while the
|
|
81
|
+
// per-researcher allowance is a single call, so a researcher passing one URL too
|
|
82
|
+
// many got a validation error AND lost its only call — and the retry was then told
|
|
83
|
+
// "You have already used your one youtube_transcript call", which is false. The
|
|
84
|
+
// round loses transcripts entirely. grep and search already validate first.
|
|
90
85
|
if (!Value.Check(YoutubeParamsSchema, params)) {
|
|
91
86
|
metrics.increment('tool_youtube_transcript_calls_total', 1, { status: 'invalid_params' });
|
|
92
87
|
return {
|
|
@@ -105,6 +100,19 @@ export function createYoutubeTranscriptTool(options: {
|
|
|
105
100
|
};
|
|
106
101
|
}
|
|
107
102
|
|
|
103
|
+
// Rate-limit enforcement (one call per researcher), now that the call is one that
|
|
104
|
+
// would actually do work.
|
|
105
|
+
if (tracker) {
|
|
106
|
+
const allowed = tracker.recordCall('youtube_transcript');
|
|
107
|
+
if (!allowed) {
|
|
108
|
+
metrics.increment('tool_youtube_transcript_calls_total', 1, { status: 'rate_limited' });
|
|
109
|
+
return {
|
|
110
|
+
content: [{ type: 'text', text: tracker.getLimitMessage('youtube_transcript') }],
|
|
111
|
+
details: { blocked: true, reason: 'limit_reached' },
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
108
116
|
// Resolve config against the live cwd for timeout/lang. The video cap stays
|
|
109
117
|
// `maxVideos` (the factory value the schema's maxItems was built from) so the
|
|
110
118
|
// schema gate and the command-level cap can never disagree. The PoToken
|
|
@@ -151,6 +159,12 @@ export function createYoutubeTranscriptTool(options: {
|
|
|
151
159
|
|
|
152
160
|
return result;
|
|
153
161
|
} catch (error) {
|
|
162
|
+
// A cancelled batch is not bot-protection — see isCancellation. "Continue
|
|
163
|
+
// with the rest of your research" is the opposite of what a Ctrl-C means.
|
|
164
|
+
if (isCancellation(error, signal)) {
|
|
165
|
+
metrics.increment('tool_youtube_transcript_calls_total', 1, { status: 'cancelled' });
|
|
166
|
+
throw error;
|
|
167
|
+
}
|
|
154
168
|
const errorMsg = error instanceof Error ? error.message : String(error);
|
|
155
169
|
logger.error(`[youtube_transcript tool] Failed: ${errorMsg}`);
|
|
156
170
|
metrics.increment('tool_youtube_transcript_calls_total', 1, { status: 'error' });
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cancellation detection shared by the agent-facing tools.
|
|
3
|
+
*
|
|
4
|
+
* Every tool wrapper is built to never throw: a failure becomes prose the agent
|
|
5
|
+
* reads and acts on. That contract is right for a failure and wrong for a
|
|
6
|
+
* cancellation, because the prose is written to explain a *fault* — "this may be
|
|
7
|
+
* due to API rate limiting", "unable to search security databases, try again
|
|
8
|
+
* later", "may be due to network issues or YouTube bot-protection". When the user
|
|
9
|
+
* presses Ctrl-C, the in-flight work rejects with an abort and those sentences are
|
|
10
|
+
* simply false. The agent believes them: it retries, spends budget the user just
|
|
11
|
+
* asked it to stop spending, and can carry the invented cause into the report.
|
|
12
|
+
*
|
|
13
|
+
* A cancellation must therefore propagate. The run is ending either way, and the
|
|
14
|
+
* throw is what unwinds the agent loop instead of feeding it a fabricated fault.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* True when `error` represents the abort of `signal` (or an abort in general)
|
|
19
|
+
* rather than a genuine failure of the work.
|
|
20
|
+
*
|
|
21
|
+
* The message-shape check is the load-bearing part in practice. Cancellation
|
|
22
|
+
* crosses several layers here — worker IPC, HTTP to the browser leader, the
|
|
23
|
+
* research orchestrator's own abort plumbing — and only some of them preserve
|
|
24
|
+
* `AbortError` as the error name; the rest arrive as a plain Error whose message
|
|
25
|
+
* is the reason string. `signal.aborted` alone is not sufficient either: a tool
|
|
26
|
+
* may be handed no signal at all, and a signal can abort after the failure it is
|
|
27
|
+
* being asked to explain.
|
|
28
|
+
*/
|
|
29
|
+
export function isCancellation(error: unknown, signal?: AbortSignal | null): boolean {
|
|
30
|
+
if (signal?.aborted) return true;
|
|
31
|
+
if (error instanceof Error && error.name === 'AbortError') return true;
|
|
32
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
33
|
+
return /^(aborted|the operation was aborted|research (aborted|cancelled|canceled)|operation cancelled|operation canceled)\.?$/i.test(
|
|
34
|
+
message.trim(),
|
|
35
|
+
);
|
|
36
|
+
}
|