Skip to content

Tool Reference

Rob Joy edited this page Apr 1, 2026 · 4 revisions

Tool Reference

SymForge currently exposes 31 tools plus prompts and resources.

Use this page for

looking up the right tool family after SymForge is already installed and connected in your client.

Orientation

Tool Purpose
health Index status, watcher state, token savings, adoption metrics
get_repo_map Repository overview with adjustable detail
explore Concept-driven exploration across symbols, files, and patterns

Reading Code

Tool Purpose
get_file_content Exact file reads, line ranges, around-match, around-symbol
get_file_context File outline, imports, consumers, references, git context
get_symbol Focused symbol retrieval by file and name
get_symbol_context Symbol body plus callers, callees, types, or expanded bundles

Searching

Tool Purpose
search_symbols Find symbols by name, kind, language, or path
search_text Full-text search with enclosing symbol context
search_files Ranked file discovery and path resolution

References and Dependencies

Tool Purpose
find_references Call sites, imports, type usages, implementations
find_dependents File-level dependency graph
inspect_match Deep-dive on a text search hit

Git and Change Inspection

Tool Purpose
what_changed Changed files by git ref, timestamp, or working tree
analyze_file_impact Reindex one file and report affected symbols and dependents
diff_symbols Symbol-level git diff

Validation

Tool Purpose
validate_file_syntax Parse and validate TOML, JSON, YAML, and similar configs

Editing

Tool Purpose
replace_symbol_body Replace an entire symbol definition
edit_within_symbol Scoped find/replace inside one symbol
insert_symbol Insert before or after a named symbol
delete_symbol Delete a symbol and its attached doc comments
batch_edit Apply multiple symbol-addressed edits atomically
batch_rename Rename a symbol and update references
batch_insert Insert the same content at multiple symbol locations

Agent-oriented helpers

Tool Purpose
ask Natural-language routing to the right SymForge tool
conventions Infer coding conventions from the indexed project
edit_plan Assess impact and suggest the correct edit sequence
context_inventory Show what code has already been loaded this session
investigation_suggest Suggest next investigation targets
index_folder Reindex a directory from scratch

Practical defaults

  • Use get_file_context before reading source files.
  • Use search_symbols or search_text before broad raw file scanning.
  • Use get_file_content for docs and config where exact wording matters.
  • Use edit_plan before non-trivial edits.
  • Use analyze_file_impact after small edits and index_folder after large ones.

Tip

The fastest mental model is: orient with get_repo_map or explore, narrow with search_*, inspect with get_*, then edit with the symbol-aware edit tools.

Edit behavior

SymForge edit tools are intended to replace raw text-copy editing for source code.

Important behaviors:

  • symbol-addressed range resolution
  • doc-comment-aware edit ranges
  • automatic indentation
  • atomic writes
  • immediate reindexing
  • stale-callsite warnings on signature changes where applicable

Prompts

SymForge also exposes prompts for higher-level workflows:

  • symforge-review
  • symforge-architecture
  • symforge-triage
  • symforge-onboard
  • symforge-refactor
  • symforge-debug

These prompts return procedural workflows that tell the agent which SymForge tools to call next.

Resources

Static resources:

  • symforge://repo/health
  • symforge://repo/outline
  • symforge://repo/map
  • symforge://repo/changes/uncommitted

Resource templates:

  • symforge://file/context?...
  • symforge://file/content?...
  • symforge://symbol/detail?...
  • symforge://symbol/context?...

Clone this wiki locally