-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathapp.py
More file actions
1106 lines (1038 loc) · 53.1 KB
/
Copy pathapp.py
File metadata and controls
1106 lines (1038 loc) · 53.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""High-level application facade for Moonshine."""
from __future__ import annotations
import json
from dataclasses import dataclass, field
from pathlib import Path
from typing import Dict, List, Optional
from moonshine.agents.manager import AgentManager
from moonshine.agent_runtime.model_metadata import DEFAULT_CONTEXT_WINDOW_TOKENS, resolve_model_context_window
from moonshine.agent_runtime.context_manager import ContextManager
from moonshine.agent_runtime.memory_manager import MemoryManager
from moonshine.agent_runtime.research_mode import PENDING_RESEARCH_PROJECT, ResearchProjectResolver
from moonshine.credentials import credential_source, get_credential, load_credentials_into_environment, set_credential
from moonshine.moonshine_cli.commands import execute_slash_command
from moonshine.moonshine_cli.config import ensure_project_layout, ensure_runtime_home, load_config, resolve_home, save_config
from moonshine.moonshine_cli.runtime_provider import resolve_archival_provider, resolve_runtime_provider, resolve_verification_provider
from moonshine.moonshine_constants import MoonshinePaths
from moonshine.run_agent import AIAgent, AgentEvent
from moonshine.skills.manager import SkillManager
from moonshine.storage.session_store import SessionStore
from moonshine.tools.manager import ToolManager
from moonshine.utils import atomic_write, read_json, read_jsonl, utc_now, write_json
TAVILY_API_KEY_URL = "https://app.tavily.com/"
def render_tavily_mcp_descriptor(*, enabled: bool) -> str:
"""Render the runtime Tavily MCP descriptor without embedding secrets."""
metadata = {
"slug": "tavily",
"title": "Tavily MCP Server",
"description": "Runtime Tavily MCP server for real-time web search and page extraction.",
"transport": "stdio",
"enabled": bool(enabled),
"command": "npx",
"args": ["-y", "tavily-mcp@0.1.3"],
"env": {
"TAVILY_API_KEY": "${TAVILY_API_KEY}",
},
"discover_tools": True,
"tool_hints": [
{
"name": "tavily-search",
"description": "Search the live web with Tavily for up-to-date information.",
"parameters": {
"type": "object",
"properties": {
"query": {"type": "string", "description": "Search query."},
"topic": {"type": "string", "description": "Search topic such as general or news."},
"search_depth": {"type": "string", "description": "Search depth such as basic or advanced."},
"max_results": {"type": "integer", "description": "Maximum number of results to return."},
"include_answer": {"type": "boolean", "description": "Whether to request Tavily's direct answer summary."},
"include_raw_content": {"type": "boolean", "description": "Whether to include raw page content."},
"include_images": {"type": "boolean", "description": "Whether to include images."},
"include_favicon": {"type": "boolean", "description": "Whether to include favicons."},
"include_domains": {"type": "array", "items": {"type": "string"}, "description": "Restrict search to these domains."},
"exclude_domains": {"type": "array", "items": {"type": "string"}, "description": "Exclude these domains."},
"time_range": {"type": "string", "description": "Optional time range filter."},
"days": {"type": "integer", "description": "Limit news recency to the last N days."},
},
"required": ["query"],
"additionalProperties": True,
},
},
{
"name": "tavily-extract",
"description": "Extract clean content from one or more URLs with Tavily.",
"parameters": {
"type": "object",
"properties": {
"urls": {
"oneOf": [
{"type": "string"},
{"type": "array", "items": {"type": "string"}},
],
"description": "One URL or a list of URLs to extract.",
},
"extract_depth": {"type": "string", "description": "Extraction depth such as basic or advanced."},
"format": {"type": "string", "description": "Output format such as markdown or text."},
"query": {"type": "string", "description": "Optional extraction focus query."},
"include_images": {"type": "boolean", "description": "Whether to include images."},
"include_favicon": {"type": "boolean", "description": "Whether to include favicons."},
},
"required": ["urls"],
"additionalProperties": True,
},
},
],
"timeout_seconds": 60,
}
return """<!--
%s
-->
# Tavily MCP Server
## Purpose
- Connect Tavily as an external MCP server for real-time web search and page extraction.
- The API key is read from `TAVILY_API_KEY`, either from the process environment or from Moonshine's local credentials file.
- Get a personal Tavily API key from <https://app.tavily.com/>.
## Enable
1. Run `python -m moonshine mcp --set-tavily-key` and enter your own API key.
2. Restart Moonshine so it can register `mcp_tavily_tavily_search` and `mcp_tavily_tavily_extract`, then discover any extra Tavily MCP tools automatically.
## Safety
- Do not place a raw API key in this descriptor.
- Moonshine stores user-provided keys in `config/credentials.json`, which is created only after setup.
""" % json.dumps(metadata, ensure_ascii=False, indent=2)
@dataclass
class ShellState:
"""Mutable shell state."""
mode: str
project_slug: str
session_id: str
agent_slug: str
auto_project_pending: bool = False
research_autopilot_default_enabled: bool = True
research_report_offsets: Dict[str, object] = field(default_factory=dict)
class MoonshineApp(object):
"""Composition root for the Moonshine runtime."""
def __init__(self, home: Optional[str] = None):
self.paths = MoonshinePaths(resolve_home(home))
ensure_runtime_home(self.paths)
load_credentials_into_environment(self.paths)
self.config = load_config(self.paths)
self.session_store = SessionStore(self.paths)
self.agent_manager = AgentManager(self.paths)
self.skill_manager = SkillManager(self.paths)
self.skill_store = self.skill_manager.store
self.provider = resolve_runtime_provider(self.config)
self.verification_provider = resolve_verification_provider(self.config, fallback_provider=self.provider)
self.archival_provider = resolve_archival_provider(self.config, fallback_provider=self.provider)
self._attach_provider_config_callbacks()
self.research_project_resolver = ResearchProjectResolver(paths=self.paths, provider=self.provider)
self.memory = MemoryManager(
self.paths,
self.config,
self.session_store,
provider=self.provider,
skill_manager=self.skill_manager,
)
self.tool_manager = ToolManager(paths=self.paths)
self.tool_registry = self.tool_manager.registry
self.context_manager = ContextManager(
paths=self.paths,
config=self.config,
provider=self.provider,
memory_manager=self.memory,
session_store=self.session_store,
tool_manager=self.tool_manager,
)
self.agent = AIAgent(
config=self.config,
paths=self.paths,
provider=self.provider,
verification_provider=self.verification_provider,
archival_provider=self.archival_provider,
memory_manager=self.memory,
session_store=self.session_store,
agent_manager=self.agent_manager,
skill_manager=self.skill_manager,
tool_manager=self.tool_manager,
context_manager=self.context_manager,
)
self.ensure_project(self.config.default_project)
def _refresh_runtime_providers(self) -> None:
"""Re-resolve provider instances after config changes."""
self.provider = resolve_runtime_provider(self.config)
self.verification_provider = resolve_verification_provider(self.config, fallback_provider=self.provider)
self.archival_provider = resolve_archival_provider(self.config, fallback_provider=self.provider)
self._attach_provider_config_callbacks()
self.research_project_resolver.provider = self.provider
self.memory.set_provider(self.provider)
self.context_manager.provider = self.provider
self.agent.provider = self.provider
self.agent.verification_provider = self.verification_provider
self.agent.archival_provider = self.archival_provider
self.agent.research_workflow.provider = self.archival_provider
def _provider_config_for_target(self, target: str):
"""Return the mutable provider config object for one provider target."""
normalized = str(target or "main").strip().lower()
if normalized == "verification":
return self.config.verification_provider
if normalized == "archival":
return self.config.archival_provider
return self.config.provider
def _persist_structured_output_format(self, target: str, format_name: str) -> None:
"""Persist a structured-output format that succeeded after provider fallback."""
normalized = str(format_name or "").strip().lower()
if normalized not in {"json_schema", "json_object", "prompt"}:
return
provider_config = self._provider_config_for_target(target)
if str(getattr(provider_config, "structured_output_format", "") or "").strip().lower() == normalized:
return
provider_config.structured_output_format = normalized
save_config(self.paths, self.config)
def _attach_provider_config_callbacks(self) -> None:
"""Attach lightweight config persistence callbacks to runtime providers."""
attached_ids = set()
def attach(provider, target: str) -> None:
if provider is None or id(provider) in attached_ids:
return
attached_ids.add(id(provider))
try:
provider.structured_output_format_callback = (
lambda format_name, provider_target=target: self._persist_structured_output_format(provider_target, format_name)
)
except Exception:
pass
attach(self.provider, "main")
if self.verification_provider is not self.provider:
attach(self.verification_provider, "verification")
if self.archival_provider is not self.provider and self.archival_provider is not self.verification_provider:
attach(self.archival_provider, "archival")
def startup_notices(self) -> list:
"""Return non-blocking startup notices for optional integrations."""
notices = []
tavily = self.tool_manager.get_mcp_server("tavily")
if tavily is None:
return notices
key_source = credential_source(self.paths, "TAVILY_API_KEY")
has_key = bool(key_source)
if not has_key:
notices.append(
"[setup] Tavily web search is disabled because TAVILY_API_KEY is not set. "
"If you need web search, get your own API key from %s, then run "
"`python -m moonshine mcp --set-tavily-key` before starting Moonshine."
% TAVILY_API_KEY_URL
)
elif not tavily.enabled:
notices.append(
"[setup] Tavily API key is configured in %s, but Tavily MCP is disabled in %s. "
"Run `python -m moonshine mcp --enable-tavily` if you want Moonshine to use Tavily web search."
% (key_source, tavily.path)
)
return notices
def configure_tavily_api_key(self, api_key: str, *, enable: bool = True) -> dict:
"""Store the user's Tavily key in the runtime credential file."""
set_credential(self.paths, "TAVILY_API_KEY", api_key)
if enable:
atomic_write(self.paths.mcp_servers_dir / "tavily.md", render_tavily_mcp_descriptor(enabled=True))
return {
"credential_file": str(self.paths.credentials_file),
"descriptor_file": str(self.paths.mcp_servers_dir / "tavily.md"),
"enabled": bool(enable),
}
def set_tavily_enabled(self, enabled: bool) -> dict:
"""Enable or disable the runtime Tavily MCP descriptor."""
atomic_write(self.paths.mcp_servers_dir / "tavily.md", render_tavily_mcp_descriptor(enabled=enabled))
return {
"descriptor_file": str(self.paths.mcp_servers_dir / "tavily.md"),
"enabled": bool(enabled),
"has_key": bool(get_credential(self.paths, "TAVILY_API_KEY")),
}
def configure_azure_openai(
self,
*,
endpoint: str,
deployment: str,
api_version: str = "2024-12-01-preview",
api_key: str = "",
api_key_env: str = "AZURE_OPENAI_API_KEY",
stream: bool = True,
temperature: Optional[float] = None,
timeout_seconds: Optional[int] = None,
max_context_tokens: Optional[int] = None,
target: str = "main",
) -> dict:
"""Configure Azure OpenAI as the main or verification provider."""
endpoint = str(endpoint or "").strip().rstrip("/")
deployment = str(deployment or "").strip()
api_version = str(api_version or "2024-12-01-preview").strip()
api_key_env = str(api_key_env or "AZURE_OPENAI_API_KEY").strip()
target = str(target or "main").strip().lower()
if not endpoint:
raise ValueError("Azure OpenAI endpoint cannot be empty.")
if not deployment:
raise ValueError("Azure OpenAI deployment cannot be empty.")
if not api_key_env:
raise ValueError("Azure OpenAI api_key_env cannot be empty.")
if target not in {"main", "verification", "archival"}:
raise ValueError("Provider target must be 'main', 'verification', or 'archival'.")
if api_key:
set_credential(self.paths, api_key_env, api_key)
load_credentials_into_environment(self.paths)
provider_config = (
self.config.provider
if target == "main"
else (self.config.verification_provider if target == "verification" else self.config.archival_provider)
)
provider_config.type = "azure_openai"
provider_config.model = deployment
provider_config.base_url = endpoint
provider_config.api_key_env = api_key_env
provider_config.api_version = api_version
provider_config.stream = bool(stream)
provider_config.temperature = temperature
if target in {"verification", "archival"}:
provider_config.inherit_from_main = False
if timeout_seconds is not None:
provider_config.timeout_seconds = int(timeout_seconds)
configured_context = DEFAULT_CONTEXT_WINDOW_TOKENS if max_context_tokens is None else max_context_tokens
provider_config.max_context_tokens = resolve_model_context_window(
deployment,
configured=configured_context,
)
save_config(self.paths, self.config)
self._refresh_runtime_providers()
return {
"target": target,
"provider_type": provider_config.type,
"endpoint": provider_config.base_url,
"deployment": provider_config.model,
"api_version": provider_config.api_version,
"api_key_env": provider_config.api_key_env,
"credential_file": str(self.paths.credentials_file),
"config_file": str(self.paths.config_file),
}
def configure_openai_compatible(
self,
*,
base_url: str,
model: str,
api_key: str = "",
api_key_env: str = "OPENAI_API_KEY",
stream: bool = True,
temperature: Optional[float] = None,
reasoning_effort: str = "",
reasoning_summary: str = "",
structured_output_format: str = "json_schema",
timeout_seconds: Optional[int] = None,
max_context_tokens: Optional[int] = None,
target: str = "main",
) -> dict:
"""Configure an OpenAI-compatible chat-completions provider."""
base_url = str(base_url or "").strip().rstrip("/")
model = str(model or "").strip()
api_key_env = str(api_key_env or "OPENAI_API_KEY").strip()
target = str(target or "main").strip().lower()
if not base_url:
raise ValueError("OpenAI-compatible base_url cannot be empty.")
if not model:
raise ValueError("OpenAI-compatible model cannot be empty.")
if not api_key_env:
raise ValueError("OpenAI-compatible api_key_env cannot be empty.")
if target not in {"main", "verification", "archival"}:
raise ValueError("Provider target must be 'main', 'verification', or 'archival'.")
if api_key:
set_credential(self.paths, api_key_env, api_key)
load_credentials_into_environment(self.paths)
provider_config = (
self.config.provider
if target == "main"
else (self.config.verification_provider if target == "verification" else self.config.archival_provider)
)
provider_config.type = "openai_compatible"
provider_config.model = model
provider_config.base_url = base_url
provider_config.api_key_env = api_key_env
provider_config.api_version = ""
provider_config.stream = bool(stream)
provider_config.temperature = temperature
provider_config.reasoning_effort = str(reasoning_effort or "").strip()
provider_config.reasoning_summary = str(reasoning_summary or "").strip()
provider_config.structured_output_format = str(structured_output_format or "json_schema").strip().lower()
if target in {"verification", "archival"}:
provider_config.inherit_from_main = False
if timeout_seconds is not None:
provider_config.timeout_seconds = int(timeout_seconds)
configured_context = DEFAULT_CONTEXT_WINDOW_TOKENS if max_context_tokens is None else max_context_tokens
provider_config.max_context_tokens = resolve_model_context_window(
model,
configured=configured_context,
)
save_config(self.paths, self.config)
self._refresh_runtime_providers()
return {
"target": target,
"provider_type": provider_config.type,
"base_url": provider_config.base_url,
"model": provider_config.model,
"api_key_env": provider_config.api_key_env,
"credential_file": str(self.paths.credentials_file),
"config_file": str(self.paths.config_file),
}
def set_verification_provider_inherit_main(self, inherit_from_main: bool = True) -> dict:
"""Switch the verification provider between inherited and dedicated modes."""
self.config.verification_provider.inherit_from_main = bool(inherit_from_main)
save_config(self.paths, self.config)
self._refresh_runtime_providers()
return {
"inherit_from_main": bool(self.config.verification_provider.inherit_from_main),
"config_file": str(self.paths.config_file),
}
def update_provider_config(
self,
*,
target: str = "main",
provider_type: Optional[str] = None,
base_url: Optional[str] = None,
model: Optional[str] = None,
api_version: Optional[str] = None,
api_key: str = "",
api_key_env: Optional[str] = None,
stream: Optional[bool] = None,
temperature: Optional[float] = None,
temperature_specified: bool = False,
reasoning_effort: Optional[str] = None,
reasoning_summary: Optional[str] = None,
structured_output_format: Optional[str] = None,
timeout_seconds: Optional[int] = None,
max_context_tokens: Optional[int] = None,
inherit_from_main: Optional[bool] = None,
) -> dict:
"""Update one provider configuration incrementally."""
target = str(target or "main").strip().lower()
if target not in {"main", "verification", "archival"}:
raise ValueError("Provider target must be 'main', 'verification', or 'archival'.")
provider_config = (
self.config.provider
if target == "main"
else (self.config.verification_provider if target == "verification" else self.config.archival_provider)
)
if inherit_from_main is not None:
if target not in {"verification", "archival"}:
raise ValueError("inherit_from_main applies only to secondary providers.")
provider_config.inherit_from_main = bool(inherit_from_main)
if provider_type is not None:
normalized = str(provider_type or "").strip().lower().replace("-", "_")
if not normalized:
raise ValueError("Provider type cannot be empty.")
provider_config.type = normalized
if target in {"verification", "archival"}:
provider_config.inherit_from_main = False
if base_url is not None:
provider_config.base_url = str(base_url or "").strip().rstrip("/")
if model is not None:
provider_config.model = str(model or "").strip()
if api_version is not None:
provider_config.api_version = str(api_version or "").strip()
if api_key_env is not None:
provider_config.api_key_env = str(api_key_env or "").strip()
if stream is not None:
provider_config.stream = bool(stream)
if temperature_specified:
provider_config.temperature = temperature
if reasoning_effort is not None:
provider_config.reasoning_effort = str(reasoning_effort or "").strip()
if reasoning_summary is not None:
normalized_reasoning_summary = str(reasoning_summary or "").strip().lower()
if normalized_reasoning_summary not in {"", "auto", "concise", "detailed"}:
raise ValueError("reasoning_summary must be empty or one of auto, concise, or detailed.")
provider_config.reasoning_summary = normalized_reasoning_summary
if structured_output_format is not None:
normalized_structured_output = str(structured_output_format or "json_schema").strip().lower()
if normalized_structured_output not in {"auto", "json_schema", "json_object", "prompt"}:
raise ValueError("structured_output_format must be one of auto, json_schema, json_object, or prompt.")
provider_config.structured_output_format = normalized_structured_output
if timeout_seconds is not None:
provider_config.timeout_seconds = int(timeout_seconds)
if max_context_tokens is not None:
provider_config.max_context_tokens = resolve_model_context_window(
provider_config.model,
configured=max_context_tokens,
)
if api_key:
key_name = str(provider_config.api_key_env or "").strip()
if not key_name:
raise ValueError("api_key_env must be set before storing a provider API key.")
set_credential(self.paths, key_name, api_key)
load_credentials_into_environment(self.paths)
if provider_config.type in {"openai_compatible", "openai_chat", "chat_completions", "openai_responses", "responses"}:
provider_config.api_version = ""
save_config(self.paths, self.config)
self._refresh_runtime_providers()
return {
"target": target,
"provider_type": str(provider_config.type or ""),
"base_url": str(provider_config.base_url or ""),
"model": str(provider_config.model or ""),
"api_version": str(provider_config.api_version or ""),
"api_key_env": str(provider_config.api_key_env or ""),
"stream": bool(provider_config.stream),
"temperature": provider_config.temperature,
"reasoning_effort": str(getattr(provider_config, "reasoning_effort", "") or ""),
"reasoning_summary": str(getattr(provider_config, "reasoning_summary", "") or ""),
"structured_output_format": str(getattr(provider_config, "structured_output_format", "json_schema") or "json_schema"),
"timeout_seconds": int(provider_config.timeout_seconds),
"max_context_tokens": int(provider_config.max_context_tokens),
"inherit_from_main": bool(getattr(provider_config, "inherit_from_main", False)) if target in {"verification", "archival"} else False,
"credential_file": str(self.paths.credentials_file),
"config_file": str(self.paths.config_file),
}
def ensure_project(self, project_slug: str) -> None:
"""Ensure a project exists."""
ensure_project_layout(self.paths, project_slug)
self.memory.ensure_project(project_slug)
def start_shell_state(
self,
mode: Optional[str] = None,
project_slug: Optional[str] = None,
agent_slug: Optional[str] = None,
session_id: Optional[str] = None,
) -> ShellState:
"""Create a new shell state or resume an existing session."""
if session_id:
session_meta = self.session_store.get_session_meta(str(session_id))
if not session_meta or not session_meta.get("id"):
raise ValueError("Session not found: %s" % session_id)
resolved_mode = str(session_meta.get("mode") or mode or self.config.default_mode).strip() or self.config.default_mode
requested_mode = str(mode or "").strip()
if requested_mode and requested_mode != resolved_mode:
raise ValueError("Session %s uses mode=%s, not %s." % (session_id, resolved_mode, requested_mode))
resolved_project = str(session_meta.get("project_slug") or project_slug or self.config.default_project).strip()
requested_project = project_slug if project_slug is not None else None
if requested_project is not None and str(requested_project).strip() != resolved_project:
raise ValueError("Session %s uses project=%s, not %s." % (session_id, resolved_project, requested_project))
auto_project_pending = resolved_mode == "research" and resolved_project == PENDING_RESEARCH_PROJECT
default_agent = "research-control-loop" if resolved_mode == "research" else self.agent_manager.default_slug
stored_agent = str(session_meta.get("agent_slug") or "").strip()
requested_agent = str(agent_slug or "").strip()
if requested_agent and stored_agent and requested_agent != stored_agent:
raise ValueError("Session %s uses agent=%s, not %s." % (session_id, stored_agent, requested_agent))
resolved_agent = stored_agent or requested_agent or default_agent
if self.agent_manager.get_agent(resolved_agent) is None:
raise ValueError("Agent not found: %s" % resolved_agent)
if not auto_project_pending:
self.ensure_project(resolved_project)
updated_at = utc_now()
self.session_store.update_session_meta(
str(session_id),
mode=resolved_mode,
project_slug=resolved_project,
agent_slug=resolved_agent,
updated_at=updated_at,
status="active",
)
self.session_store.db.update_session(str(session_id), updated_at=updated_at, status="active")
return ShellState(
mode=resolved_mode,
project_slug=resolved_project,
session_id=str(session_id),
agent_slug=resolved_agent,
auto_project_pending=auto_project_pending,
)
resolved_mode = mode or self.config.default_mode
auto_project_pending = resolved_mode == "research" and not project_slug
resolved_project = PENDING_RESEARCH_PROJECT if auto_project_pending else (project_slug or self.config.default_project)
default_agent = "research-control-loop" if resolved_mode == "research" else self.agent_manager.default_slug
resolved_agent = str(agent_slug or default_agent).strip()
if self.agent_manager.get_agent(resolved_agent) is None:
raise ValueError("Agent not found: %s" % resolved_agent)
if not auto_project_pending:
self.ensure_project(resolved_project)
session_id = self.session_store.create_session(resolved_mode, resolved_project, resolved_agent)
return ShellState(
mode=resolved_mode,
project_slug=resolved_project,
session_id=session_id,
agent_slug=resolved_agent,
auto_project_pending=auto_project_pending,
)
def _finalize_research_project(self, state: ShellState, project_slug: str, resolution: dict) -> dict:
"""Bind a pending research session to a concrete project."""
self.ensure_project(project_slug)
state.project_slug = project_slug
state.auto_project_pending = False
self.session_store.rebind_session_project(state.session_id, project_slug)
self.memory.write_manual_entry(
alias="project-context",
title="Research Project Initialization",
summary=str(resolution.get("summary") or resolution.get("title") or project_slug),
body=(
"Research project: %s\n\nSummary: %s\n\nTags: %s"
% (
str(resolution.get("title") or project_slug),
str(resolution.get("summary") or ""),
", ".join(str(tag) for tag in list(resolution.get("tags") or [])),
)
).strip(),
project_slug=project_slug,
source="research-project-resolver",
session_id=state.session_id,
source_message_role="system",
source_excerpt=str(resolution.get("summary") or ""),
)
return {"status": "ready", "project_slug": project_slug}
def prepare_research_project(self, user_message: str, state: ShellState, *, allow_user_choice: bool = False) -> dict:
"""Resolve or propose the project for a pending research-mode session."""
if not state.auto_project_pending:
return {"status": "ready", "project_slug": state.project_slug}
resolution = self.research_project_resolver.resolve(user_message)
payload = resolution.to_dict()
candidates = list(payload.get("candidate_existing_projects") or [])
if allow_user_choice and resolution.recommended_action == "ask_user" and candidates:
return {
"status": "needs_choice",
"resolution": payload,
"candidates": candidates,
"new_project_slug": resolution.slug,
}
if resolution.recommended_action == "reuse_existing" and resolution.selected_project_slug:
return self._finalize_research_project(state, resolution.selected_project_slug, payload)
return self._finalize_research_project(state, resolution.slug, payload)
def finalize_research_project_choice(self, state: ShellState, resolution: dict, selected_project_slug: str = "") -> dict:
"""Finalize a user-selected research project choice."""
target = selected_project_slug or str(resolution.get("slug") or "").strip()
if not target:
target = str(resolution.get("new_project_slug") or "research_project")
return self._finalize_research_project(state, target, resolution)
def switch_project_session(self, state: ShellState, project_slug: str) -> dict:
"""Switch project scope and start a fresh session for the new project."""
if project_slug == state.project_slug:
return {
"changed": False,
"project_slug": state.project_slug,
"session_id": state.session_id,
"previous_session_id": state.session_id,
}
previous_session_id = state.session_id
self.close_session(state)
replacement = self.start_shell_state(mode=state.mode, project_slug=project_slug, agent_slug=state.agent_slug)
state.project_slug = replacement.project_slug
state.session_id = replacement.session_id
state.mode = replacement.mode
state.agent_slug = replacement.agent_slug
state.research_report_offsets = {}
return {
"changed": True,
"project_slug": state.project_slug,
"session_id": state.session_id,
"previous_session_id": previous_session_id,
}
def _jsonl_count(self, path: Path) -> int:
"""Return a safe JSONL record count for offset tracking."""
return len(read_jsonl(path))
def _research_final_report_enabled(self) -> bool:
"""Return whether verified-run report generation is enabled."""
return bool(getattr(self.config.agent, "research_final_report_enabled", True))
def _research_report_offset_key(self, state: ShellState) -> str:
"""Return the stable key for the current project/session report window."""
return "%s:%s" % (state.project_slug, state.session_id)
def _research_report_offset_file(self, state: ShellState) -> Path:
"""Return the persisted report-offset file for this session."""
return self.paths.session_research_report_offset_file(state.session_id)
def _load_research_report_offsets(self, state: ShellState) -> Dict[str, object]:
"""Load persisted report offsets for this project/session."""
path = self._research_report_offset_file(state)
try:
payload = read_json(path, default={}) or {}
except (OSError, ValueError):
return {}
if not isinstance(payload, dict):
return {}
current_key = self._research_report_offset_key(state)
if str(payload.get("key") or "") != current_key:
return {}
if str(payload.get("project_slug") or "") != state.project_slug:
return {}
if str(payload.get("session_id") or "") != state.session_id:
return {}
return dict(payload)
def _persist_research_report_offsets(self, state: ShellState, offsets: Dict[str, object]) -> None:
"""Persist report offsets so failed report generation survives restart."""
payload = dict(offsets or {})
if not payload:
return
payload.setdefault("created_at", utc_now())
payload["updated_at"] = utc_now()
write_json(self._research_report_offset_file(state), payload)
def _ensure_research_report_offsets(self, state: ShellState) -> Dict[str, object]:
"""Create a persistent report offset for the current research run."""
if state.mode != "research" or state.auto_project_pending:
return {}
current_key = self._research_report_offset_key(state)
if str(state.research_report_offsets.get("key") or "") == current_key:
if self._research_report_offset_file(state).exists():
return state.research_report_offsets
state.research_report_offsets = {}
persisted = self._load_research_report_offsets(state)
if persisted:
state.research_report_offsets = persisted
return persisted
offsets = {
"key": current_key,
"project_slug": state.project_slug,
"session_id": state.session_id,
"messages": self._jsonl_count(self.paths.session_messages_file(state.session_id)),
"tool_events": self._jsonl_count(self.paths.session_tool_events_file(state.session_id)),
"research_log": self._jsonl_count(self.paths.project_research_log_file(state.project_slug)),
"created_at": utc_now(),
}
state.research_report_offsets = offsets
self._persist_research_report_offsets(state, offsets)
return offsets
def _clear_research_report_offsets(self, state: ShellState) -> None:
"""Clear report offsets after a final report has been written."""
state.research_report_offsets = {}
try:
self._research_report_offset_file(state).unlink()
except FileNotFoundError:
pass
except OSError:
pass
def _project_research_report_offset_payloads(self, state: ShellState) -> List[Dict[str, object]]:
"""Return pending report offsets for all sessions in the current project."""
rows: List[Dict[str, object]] = []
seen = set()
for path in self.paths.sessions_dir.glob("*/artifacts/research_report_offset.json"):
try:
payload = read_json(path, default={}) or {}
except (OSError, ValueError):
continue
if not isinstance(payload, dict):
continue
if str(payload.get("project_slug") or "") != state.project_slug:
continue
session_id = str(payload.get("session_id") or "").strip()
if not session_id:
continue
if str(payload.get("key") or "") != "%s:%s" % (state.project_slug, session_id):
continue
payload = dict(payload)
payload["_offset_path"] = str(path)
rows.append(payload)
seen.add(session_id)
current = dict(state.research_report_offsets or {})
current_session = str(current.get("session_id") or "").strip()
if current_session and str(current.get("project_slug") or "") == state.project_slug and current_session not in seen:
rows.append(current)
rows.sort(key=lambda item: (str(item.get("created_at") or ""), str(item.get("session_id") or "")))
return rows
def _final_report_generation_offsets(self, state: ShellState, offsets: Dict[str, object]) -> Dict[str, object]:
"""Combine all pending project/session offsets for one project-level report."""
base = dict(offsets or {})
pending = self._project_research_report_offset_payloads(state)
if not pending and base:
pending = [base]
session_windows = []
research_log_offsets = []
for item in pending:
session_id = str(item.get("session_id") or "").strip()
if not session_id:
continue
session_windows.append(
{
"session_id": session_id,
"messages": int(item.get("messages") or 0),
"tool_events": int(item.get("tool_events") or 0),
}
)
try:
research_log_offsets.append(max(0, int(item.get("research_log") or 0)))
except (TypeError, ValueError):
pass
if session_windows:
base["pending_sessions"] = session_windows
if research_log_offsets:
base["research_log"] = min(research_log_offsets)
return base
def _clear_project_research_report_offsets(self, state: ShellState) -> None:
"""Clear all pending report offsets for this project after a project report is written."""
for payload in self._project_research_report_offset_payloads(state):
path_text = str(payload.get("_offset_path") or "").strip()
if not path_text:
continue
try:
Path(path_text).unlink()
except FileNotFoundError:
pass
except OSError:
pass
state.research_report_offsets = {}
def _is_final_verification_passed_event(self, event: AgentEvent) -> bool:
"""Return True when an event is a passing final verify_overall result."""
if event.type != "tool_result" or event.text != "verify_overall":
return False
try:
output = dict(event.payload.get("output") or {})
except (TypeError, ValueError):
return False
scope = str(output.get("scope") or "").strip().lower()
return bool(output.get("passed")) and scope == "final"
def _generate_final_research_report_with_provider(
self,
provider,
*,
project_slug: str,
session_id: str,
offsets: Dict[str, object],
retries: int,
) -> Dict[str, object]:
"""Run final report generation with a selected provider."""
workflow = self.agent.research_workflow
previous_provider = workflow.provider
workflow.provider = provider
try:
return workflow.generate_final_report(
project_slug=project_slug,
session_id=session_id,
offsets=offsets,
retries=retries,
)
finally:
workflow.provider = previous_provider
def _final_report_failed(self, payload: Dict[str, object]) -> bool:
"""Return whether a final report generation payload represents failure."""
return not bool(payload.get("written")) or bool(payload.get("error") or payload.get("skipped"))
def _emit_final_research_report_events(self, state: ShellState):
"""Generate the user-facing research report after final verification passes."""
if not self._research_final_report_enabled():
yield AgentEvent(
type="status",
text="Final research report generation is disabled; report offset retained.",
payload={"project_slug": state.project_slug, "session_id": state.session_id},
)
return
offsets = dict(state.research_report_offsets or {})
if not offsets:
offsets = self._ensure_research_report_offsets(state)
if not offsets:
return
offsets = self._final_report_generation_offsets(state, offsets)
retries = max(1, int(getattr(self.config.agent, "research_final_report_retries", 3) or 3))
yield AgentEvent(
type="status",
text="Generating final research report from the verified run.",
payload={"project_slug": state.project_slug, "session_id": state.session_id},
)
payload = self._generate_final_research_report_with_provider(
self.archival_provider,
project_slug=state.project_slug,
session_id=state.session_id,
offsets=offsets,
retries=retries,
)
archival_inherits_main = bool(getattr(self.config.archival_provider, "inherit_from_main", True))
if (
self._final_report_failed(dict(payload or {}))
and not archival_inherits_main
and self.archival_provider is not self.provider
):
yield AgentEvent(
type="status",
text="Dedicated archival provider failed while generating the final research report; retrying with the main provider.",
payload={"project_slug": state.project_slug, "error": dict(payload or {}).get("error") or dict(payload or {}).get("skipped")},
)
fallback_payload = self._generate_final_research_report_with_provider(
self.provider,
project_slug=state.project_slug,
session_id=state.session_id,
offsets=offsets,
retries=retries,
)
fallback_payload = dict(fallback_payload or {})
fallback_payload["fallback_provider"] = "main"
fallback_payload["primary_archival_error"] = {
key: value
for key, value in dict(payload or {}).items()
if key in {"error", "skipped", "written"}
}
payload = fallback_payload
payload = dict(payload or {})
if payload.get("written"):
self._clear_project_research_report_offsets(state)
yield AgentEvent(
type="status",
text="Final research report written: %s" % str(payload.get("report_path") or ""),
payload={"research_report": payload},
)
return
yield AgentEvent(
type="status",
text="Final research report generation failed: %s" % str(payload.get("error") or payload.get("skipped") or "unknown failure"),
payload={"research_report": payload},
)
def stage_input_file(self, source_path: str, *, project_slug: str = "") -> dict:
"""Make an external text input readable through read_runtime_file."""
raw = str(source_path or "").strip()
if not raw:
raise ValueError("input file path cannot be empty")
source = Path(raw).expanduser()
if not source.is_absolute():
source = (Path.cwd() / source).resolve()
else:
source = source.resolve()
if not source.exists() or not source.is_file():
raise ValueError("input file does not exist: %s" % source)
home = self.paths.home.resolve()
try:
relative_path = source.relative_to(home).as_posix()
return {
"relative_path": relative_path,
"runtime_path": str(source),
"staged": False,
}
except ValueError:
pass
if project_slug:
self.ensure_project(project_slug)
target_dir = self.paths.project_reference_notes_dir(project_slug)
else:
target_dir = self.paths.home / "inputs"
target_dir.mkdir(parents=True, exist_ok=True)
target = target_dir / source.name
suffix = 1
while target.exists() and target.read_text(encoding="utf-8") != source.read_text(encoding="utf-8"):
stem = source.stem
extension = source.suffix
target = target_dir / ("%s_%s%s" % (stem, suffix, extension))
suffix += 1
atomic_write(target, source.read_text(encoding="utf-8"))
return {
"relative_path": target.relative_to(home).as_posix(),
"runtime_path": str(target),
"staged": True,
}
def ask(self, user_message: str, state: ShellState) -> str:
"""Run one user turn."""
final_text = ""
for event in self.ask_stream(user_message, state):
if event.type == "final":
final_text = str(event.text or "")
return final_text
def ask_stream(self, user_message: str, state: ShellState):
"""Stream one user turn as agent events."""
if state.auto_project_pending:
self.prepare_research_project(user_message, state, allow_user_choice=False)
self._ensure_research_report_offsets(state)
if self._research_final_report_enabled():
if not state.research_report_offsets:
self._ensure_research_report_offsets(state)
final_verification_passed = False
for event in self.agent.run_conversation_events(
user_message=user_message,
mode=state.mode,
project_slug=state.project_slug,
session_id=state.session_id,
agent_slug=state.agent_slug,
):
if self._is_final_verification_passed_event(event):
final_verification_passed = True
if event.type == "final" and final_verification_passed and str(event.payload.get("reason") or "") not in {
"provider_offline",
"verification_provider_offline",
"archival_provider_offline",