Package, API and terminology reference
This reference is a navigation layer over current package metadata and source. Configuration is owned by the configuration guide, CLI syntax by the CLI reference, and dated MCP behavior by the migration matrix. Keeping one owner per subject avoids divergent “complete configuration” copies.
Package map
All 16 workspace packages below declare version 0.1.0a3 and Python>=3.13.4.
The root friday-framework distribution is metadata-only: it aggregates a core
cohort and optional integrations, but exposes no friday_framework module.
Install only the components/extras your application needs.
| Directory | Distribution | Import |
|---|---|---|
| friday-agent | friday-framework-agent |
friday_agent |
| friday-chat | friday-chat |
friday_chat |
| friday-cli | friday-framework-cli |
friday_cli |
| friday-core | friday-framework-core |
friday_core |
| friday-finance | friday-framework-finance |
friday_finance |
| friday-llm | friday-framework-llm |
friday_llm |
| friday-mcp | friday-framework-mcp |
friday_mcp |
| friday-memory | friday-framework-memory |
friday_memory |
| friday-moltbook | friday-framework-moltbook |
friday_moltbook |
| friday-optimization | friday-framework-optimization |
friday_opt |
| friday-runtime | friday-framework-runtime |
friday_runtime |
| friday-sandbox | friday-framework-sandbox |
friday_sandbox |
| friday-speech | friday-framework-speech |
friday_speech |
| friday-telemetry | friday-framework-telemetry |
friday_telemetry |
| friday-tools | friday-framework-tools |
friday_tools |
| friday-transcript | friday-framework-transcript |
friday_transcript |
Public API entry points
| Need | Entry points | Detailed guide |
|---|---|---|
| Core contracts | LLMClient, EmbeddingModel, memory adapters, ToolDefinition, ToolRegistry, MemoryProfile |
Architecture |
| Model requests | LiteLLMService, ChatCompletionRequest, GenerationConfig, GenerationOverrides, typed events |
Advanced integration |
| Model profiles | ModelLibrary, service bindings, profile resolution and service specs |
Configuration |
| Memory | MemoryController, ContextAssembler, PromptArchitect, concrete adapters, extraction/maintenance contracts |
Memory |
| Transcripts | TranscriptSession, TranscriptEntry, SQLite/JSONL stores and exporters |
Durable transcripts |
| Agents | AgentProfile, AgentLoader, AgentRegistry, InteractiveAgent, AgentOrchestrator |
Agents and orchestration |
| Workflows | WorkflowLoader, WorkflowEngine, flat/canonical models and dispatch contracts |
Workflows |
| Tools | FunctionTool, FridayTool, ToolResult, DefaultToolRegistry |
Tools |
| Composition | RuntimeConfig, RuntimeKernel |
Runtime ownership |
| Telemetry | TelemetryInterface, create_telemetry, ManagedTelemetry, provider/event models |
Telemetry |
| MCP | Dated clients, adapters, modern tools-server APIs | Client / server |
| Speech | SpeechConfig, SpeechService, SpeechHarness, AdapterRegistry |
Speech |
An export is not a promise of complete functionality. AutonomousAgent raises
NotImplementedError, Optimization remains a skeleton, and some integration
tools below are stubs. Inspect capability status before
planning an application around a declared name.
Native tool source catalog
This inventory covers statically named tool classes found in the Tools source at the reviewed release. It includes alternative classes with the same name; choose one intentionally rather than registering colliding implementations. Input fields are names from declared Pydantic models, not a claim that every field is required. Follow each source link for defaults, validators, inherited fields and return/error behavior.
“Implementation present” means code is present, not that credentials,
dependencies, runtime registration, live operation or safe isolation were
validated. A “stub” raises or returns an explicit unimplemented outcome. Runtime
membership is shown by /tools; MCP tools are dynamically discovered and
are not part of this static table.
| Group | Tool name | Class / input fields | Implementation |
|---|---|---|---|
| archive | archive_create |
ArchiveCreateTool; see schema/source | implementation present |
| archive | archive_extract |
ArchiveExtractTool; see schema/source | implementation present |
| archive | archive_list |
ArchiveListTool; see schema/source | implementation present |
| code | code_parse_ast |
CodeParseAstTool; see schema/source | implementation present |
| code | code_extract_symbols |
CodeExtractSymbolsTool; see schema/source | implementation present |
| code | code_format |
CodeFormatTool; see schema/source | implementation present |
| code | code_lint |
CodeLintTool; see schema/source | implementation present |
| codegen | code_generate |
CodeGenerationTool; see schema/source | implementation present |
| data | csv_read |
CsvReadTool; see schema/source | implementation present |
| data | csv_write |
CsvWriteTool; see schema/source | implementation present |
| data | json_read |
JsonReadTool; see schema/source | implementation present |
| data | json_write |
JsonWriteTool; see schema/source | implementation present |
| data | json_query |
JsonQueryTool; see schema/source | implementation present |
| data | toml_read |
TomlReadTool; see schema/source | implementation present |
| data | toml_write |
TomlWriteTool; see schema/source | implementation present |
| data | xml_read |
XmlReadTool; see schema/source | implementation present |
| data | xml_query |
XmlQueryTool; see schema/source | implementation present |
| data | yaml_read |
YamlReadTool; see schema/source | implementation present |
| data | yaml_write |
YamlWriteTool; see schema/source | implementation present |
| encoding | base64_encode |
Base64EncodeTool; see schema/source | implementation present |
| encoding | base64_decode |
Base64DecodeTool; see schema/source | implementation present |
| encoding | hash_compute |
HashComputeTool; see schema/source | implementation present |
| encoding | uuid_generate |
UuidGenerateTool; see schema/source | implementation present |
| encoding | url_encode |
UrlEncodeTool; see schema/source | implementation present |
| encoding | url_decode |
UrlDecodeTool; see schema/source | implementation present |
| execution | python_execute |
PythonExecuteTool; see schema/source | implementation present |
| execution | python_execute_unsandboxed |
UnsandboxedPythonExecuteTool; see schema/source | implementation present |
| filesystem | directory_list |
DirectoryListTool; path, pattern, show_hidden, sort_by | implementation present |
| filesystem | directory_list |
DirectoryListToolLegacy; see schema/source | implementation present |
| filesystem | directory_tree |
DirectoryTreeTool; see schema/source | implementation present |
| filesystem | directory_create |
DirectoryCreateTool; see schema/source | implementation present |
| filesystem | file_search |
FileSearchTool; see schema/source | implementation present |
| filesystem | file_copy |
FileCopyTool; see schema/source | implementation present |
| filesystem | file_move |
FileMoveTool; see schema/source | implementation present |
| filesystem | file_delete |
FileDeleteTool; see schema/source | implementation present |
| filesystem | file_chmod |
FileChmodTool; see schema/source | implementation present |
| filesystem | file_read |
FileReadTool; path, encoding, start_line, max_lines | implementation present |
| filesystem | file_read_lines |
FileReadLinesTool; see schema/source | implementation present |
| filesystem | file_info |
FileInfoTool; see schema/source | implementation present |
| filesystem | file_grep |
FileGrepTool; see schema/source | implementation present |
| filesystem | smart_read |
SmartFileReadTool; path, add_to_context, store_to_memory, description, force_chunked, force_reprocess | implementation present |
| filesystem | file_write |
FileWriteTool; path, content, mode, overwrite, encoding, create_dirs | implementation present |
| filesystem | file_append |
FileAppendTool; see schema/source | implementation present |
| filesystem | file_insert |
FileInsertTool; see schema/source | implementation present |
| filesystem | file_replace |
FileReplaceTool; see schema/source | implementation present |
| filesystem | file_patch |
FilePatchTool; see schema/source | implementation present |
| finance | get_market_data |
GetMarketDataTool; see schema/source | implementation present |
| finance | get_crypto_data |
GetCryptoDataTool; see schema/source | implementation present |
| finance | get_technical_analysis |
GetTechnicalAnalysisTool; see schema/source | implementation present |
| git | git_branch_list |
GitBranchListTool; see schema/source | implementation present |
| git | git_branch_create |
GitBranchCreateTool; see schema/source | implementation present |
| git | git_checkout |
GitCheckoutTool; see schema/source | implementation present |
| git | git_add |
GitAddTool; see schema/source | implementation present |
| git | git_commit |
GitCommitTool; see schema/source | implementation present |
| git | git_stash |
GitStashTool; see schema/source | implementation present |
| git | git_status |
GitStatusTool; see schema/source | implementation present |
| git | git_diff |
GitDiffTool; see schema/source | implementation present |
| git | git_log |
GitLogTool; see schema/source | implementation present |
| git | git_show |
GitShowTool; see schema/source | implementation present |
| integrations | calendar_create_event |
CalendarCreateEventTool; see schema/source | stub |
| integrations | calendar_list_events |
CalendarListEventsTool; see schema/source | stub |
| integrations | database_query |
DatabaseQueryTool; see schema/source | stub |
| integrations | email_send |
EmailSendTool; see schema/source | stub |
| integrations | moltbook_register_agent |
MoltbookRegisterAgentTool; see schema/source | implementation present |
| integrations | moltbook_get_my_profile |
MoltbookGetMyProfileTool; see schema/source | implementation present |
| integrations | moltbook_get_claim_status |
MoltbookGetClaimStatusTool; see schema/source | implementation present |
| integrations | moltbook_update_profile |
MoltbookUpdateProfileTool; see schema/source | implementation present |
| integrations | moltbook_upload_avatar |
MoltbookUploadAvatarTool; see schema/source | implementation present |
| integrations | moltbook_delete_avatar |
MoltbookDeleteAvatarTool; see schema/source | implementation present |
| integrations | moltbook_get_agent_profile |
MoltbookGetAgentProfileTool; see schema/source | implementation present |
| integrations | moltbook_create_post |
MoltbookCreatePostTool; see schema/source | implementation present |
| integrations | moltbook_create_link_post |
MoltbookCreateLinkPostTool; see schema/source | implementation present |
| integrations | moltbook_get_feed |
MoltbookGetFeedTool; see schema/source | implementation present |
| integrations | moltbook_get_submolt_posts |
MoltbookGetSubmoltPostsTool; see schema/source | implementation present |
| integrations | moltbook_get_submolt_feed |
MoltbookGetSubmoltFeedTool; see schema/source | implementation present |
| integrations | moltbook_get_post |
MoltbookGetPostTool; see schema/source | implementation present |
| integrations | moltbook_delete_post |
MoltbookDeletePostTool; see schema/source | implementation present |
| integrations | moltbook_add_comment |
MoltbookAddCommentTool; see schema/source | implementation present |
| integrations | moltbook_reply_to_comment |
MoltbookReplyToCommentTool; see schema/source | implementation present |
| integrations | moltbook_get_comments |
MoltbookGetCommentsTool; see schema/source | implementation present |
| integrations | moltbook_upvote_post |
MoltbookUpvotePostTool; see schema/source | implementation present |
| integrations | moltbook_downvote_post |
MoltbookDownvotePostTool; see schema/source | implementation present |
| integrations | moltbook_upvote_comment |
MoltbookUpvoteCommentTool; see schema/source | implementation present |
| integrations | moltbook_create_submolt |
MoltbookCreateSubmoltTool; see schema/source | implementation present |
| integrations | moltbook_list_submolts |
MoltbookListSubmoltsTool; see schema/source | implementation present |
| integrations | moltbook_get_submolt |
MoltbookGetSubmoltTool; see schema/source | implementation present |
| integrations | moltbook_subscribe_submolt |
MoltbookSubscribeSubmoltTool; see schema/source | implementation present |
| integrations | moltbook_unsubscribe_submolt |
MoltbookUnsubscribeSubmoltTool; see schema/source | implementation present |
| integrations | moltbook_follow_agent |
MoltbookFollowAgentTool; see schema/source | implementation present |
| integrations | moltbook_unfollow_agent |
MoltbookUnfollowAgentTool; see schema/source | implementation present |
| integrations | moltbook_get_personal_feed |
MoltbookGetPersonalFeedTool; see schema/source | implementation present |
| integrations | moltbook_search |
MoltbookSearchTool; see schema/source | implementation present |
| integrations | moltbook_pin_post |
MoltbookPinPostTool; see schema/source | implementation present |
| integrations | moltbook_unpin_post |
MoltbookUnpinPostTool; see schema/source | implementation present |
| integrations | moltbook_update_submolt_settings |
MoltbookUpdateSubmoltSettingsTool; see schema/source | implementation present |
| integrations | moltbook_upload_submolt_avatar |
MoltbookUploadSubmoltAvatarTool; see schema/source | implementation present |
| integrations | moltbook_upload_submolt_banner |
MoltbookUploadSubmoltBannerTool; see schema/source | implementation present |
| integrations | moltbook_add_moderator |
MoltbookAddModeratorTool; see schema/source | implementation present |
| integrations | moltbook_remove_moderator |
MoltbookRemoveModeratorTool; see schema/source | implementation present |
| integrations | moltbook_list_moderators |
MoltbookListModeratorsTool; see schema/source | implementation present |
| integrations | slack_send |
SlackSendTool; see schema/source | stub |
| integrations | webhook_call |
WebhookCallTool; see schema/source | stub |
| math | calculator |
CalculatorTool; see schema/source | implementation present |
| math | unit_convert |
UnitConvertTool; see schema/source | implementation present |
| math | date_parse |
DateParseTool; see schema/source | implementation present |
| math | date_format |
DateFormatTool; see schema/source | implementation present |
| math | date_calculate |
DateCalculateTool; see schema/source | implementation present |
| memory | memory_stats |
MemoryStatsTool; session_id | implementation present |
| memory | graph_inspect |
GraphInspectionTool; limit, node_type | implementation present |
| memory | vector_inspect |
VectorInspectionTool; limit, doc_type, query | implementation present |
| memory | memory_lifecycle |
LifecycleTool; action, dry_run | implementation present |
| memory | memory_maintain |
MemoryMaintenanceTool; operation, dry_run, backup_first | implementation present |
| memory | memory_reset |
MemoryResetTool; confirm, session_id | implementation present |
| shell | command_execute |
CommandExecuteTool; command, cwd, timeout, env | implementation present |
| shell | shell_execute |
ShellExecuteTool; see schema/source | implementation present |
| shell | shell_script |
ShellScriptTool; see schema/source | implementation present |
| shell | process_list |
ProcessListTool; see schema/source | implementation present |
| shell | process_kill |
ProcessKillTool; see schema/source | implementation present |
| shell | environment_get |
EnvironmentGetTool; see schema/source | implementation present |
| shell | system_info |
SystemInfoTool; see schema/source | implementation present |
| system | system_health |
SystemHealthTool; check_disk | implementation present |
| system | transcript_tool |
TranscriptTool; action, format, session_id, output_dir | implementation present |
| text | markdown_to_text |
MarkdownToTextTool; see schema/source | implementation present |
| text | html_to_markdown |
HtmlToMarkdownTool; see schema/source | implementation present |
| text | text_search |
TextSearchTool; see schema/source | implementation present |
| text | text_extract |
TextExtractTool; see schema/source | implementation present |
| text | text_replace |
TextReplaceTool; see schema/source | implementation present |
| text | text_split |
TextSplitTool; see schema/source | implementation present |
| text | text_join |
TextJoinTool; see schema/source | implementation present |
| text | text_template |
TextTemplateTool; see schema/source | implementation present |
| utility | get_current_datetime |
GetCurrentDateTimeTool; timezone_name, format | implementation present |
| utility | echo |
EchoTool; message | implementation present |
| web | web_fetch |
WebFetchTool; see schema/source | implementation present |
| web | web_screenshot |
WebScreenshotTool; see schema/source | stub |
| web | web_extract_links |
WebExtractLinksTool; see schema/source | implementation present |
| web | web_extract_text |
WebExtractTextTool; see schema/source | implementation present |
| web | http_get |
HttpGetTool; see schema/source | implementation present |
| web | http_post |
HttpPostTool; see schema/source | implementation present |
| web | http_put |
HttpPutTool; see schema/source | implementation present |
| web | http_delete |
HttpDeleteTool; see schema/source | implementation present |
| web | http_download |
HttpDownloadTool; see schema/source | implementation present |
| web | http_upload |
HttpUploadTool; see schema/source | implementation present |
| web | web_reader |
WebReaderTool; see schema/source | implementation present |
| web | web_search |
WebSearchTool; see schema/source | implementation present |
| web | serper_search |
SerperSearchTool; see schema/source | implementation present |
Configuration and example conventions
Guides label complete offline Python examples, complete configuration files, schema fragments and live examples. A fragment belongs at the stated location; it is not an independent application configuration. External endpoints/model identifiers are operator-selected examples unless explicitly verified otherwise.
All guide metadata records the framework release and actual review date.
status: current describes the guide's implementation basis; it does not
assert production certification, lifecycle acceptance or a new release.
Source and accepted specifications control when prose disagrees.
Migration reference
| Old assumption | Current action |
|---|---|
| Run the retired memory integration script | Use friday-chat with explicit configuration |
| Import directory/distribution names directly | Use the package map above |
| Configure all providers through one flat LLM block | Prefer canonical model-library profiles and role bindings |
| Treat local chat as all-local processing | Review extraction, embeddings, tools, speech and exporters separately |
| Treat HTTP+SSE as the newest MCP transport | Select dated stdio or Streamable HTTP profiles explicitly |
| Enable Langfuse through new local telemetry | New provider-neutral Langfuse remains queued; legacy callbacks differ |
| Use Optimization's knapsack/DSPy helpers | No implemented optimization API is shipped |
| Delete database locks to repair recall | Inspect owners, quiesce and use supported recovery |
For MCP wire/profile transitions, use the dedicated migration guide. For old/new generation controls, use the model-library contract. No universal all-store migration script or future release-date promise is provided by this guide.
Glossary
| Term | Meaning in Friday |
|---|---|
| Application | The host that owns configuration, authorization, lifecycle and paths |
| Profile | Agent identity/selection configuration, or a model-library model definition; context distinguishes them |
| Service role | An application name bound to a chat/embedding profile |
| Episodic memory | Conversation-turn history |
| Semantic memory | Text/metadata retrieved through embeddings |
| Associative memory | Entity/relationship graph |
| Priming | Initial context retrieval, optionally including earlier-session turns |
| Context payload | Retrieved/filtered/pruned material before final model message formatting |
| Compaction | Summarization/deduplication/promotion work intended to reduce future context load |
| Lifecycle decay | Stage/retention scoring based on configured access/age rules |
| Inclusion score | Retrieval priority combining similarity, age and usage; not factual confidence |
| Provenance | Source/author/time/trust metadata attached to a record or operation |
| Namespace | An application-defined visibility partition, not authentication by itself |
| Handoff | Explicit result/artifact/context passed between tasks or agents |
| Canonical workflow | Workflow/pipeline/task hierarchy with explicit contracts |
| Quiescence | A coordinated state in which relevant owners cannot mutate the snapshot/restore participants |
| Borrowed provider | A dependency whose lifecycle remains owned by the caller |
| Closed telemetry event | A validated categorical schema with bounded allowed fields |
| MCP profile | Friday's explicitly bounded dated protocol/transport/role support |
| MRTR | Multi-round tool request continuation; not implemented in Friday's current MCP profile |