Packages
fnord
0.9.32
0.9.40
0.9.39
0.9.38
0.9.37
0.9.36
0.9.35
0.9.34
0.9.33
0.9.32
0.9.31
0.9.30
0.9.29
0.9.28
0.9.27
0.9.26
0.9.25
0.9.24
0.9.23
0.9.22
0.9.21
0.9.20
0.9.19
0.9.18
0.9.17
0.9.16
0.9.15
0.9.14
0.9.13
0.9.12
0.9.11
0.9.10
0.9.9
0.9.8
0.9.7
0.9.6
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9.0
0.8.99
0.8.98
0.8.97
0.8.96
0.8.95
0.8.94
0.8.93
0.8.92
0.8.91
0.8.90
0.8.89
0.8.88
0.8.87
0.8.86
0.8.85
0.8.84
0.8.83
0.8.82
0.8.81
0.8.80
0.8.79
0.8.78
0.8.77
0.8.76
0.8.75
0.8.74
0.8.73
0.8.72
0.8.71
0.8.70
0.8.69
0.8.68
0.8.67
0.8.66
0.8.65
0.8.64
0.8.63
0.8.62
0.8.61
0.8.60
0.8.59
0.8.58
0.8.57
0.8.56
0.8.55
0.8.54
0.8.53
0.8.52
0.8.51
0.8.50
0.8.49
0.8.48
0.8.47
0.8.46
0.8.45
0.8.44
0.8.43
0.8.42
0.8.41
0.8.40
0.8.39
0.8.38
0.8.37
0.8.36
0.8.35
0.8.34
0.8.33
0.8.32
0.8.31
0.8.30
0.8.29
0.8.27
0.8.26
0.8.25
0.8.24
0.8.23
0.8.22
0.8.21
0.8.20
0.8.19
0.8.18
0.8.17
0.8.16
0.8.15
0.8.14
0.8.13
0.8.12
0.8.11
0.8.1
0.8.0
0.7.24
0.7.23
0.7.22
0.7.21
0.7.20
0.7.19
0.7.18
0.7.17
0.7.16
0.7.15
0.7.14
0.7.13
0.7.12
0.7.11
0.7.10
0.7.9
0.7.8
0.7.7
0.7.6
0.7.5
0.7.3
0.7.2
0.7.1
0.7.0
0.6.9
0.6.8
0.6.7
0.6.6
0.6.5
0.6.4
0.6.3
0.6.1
0.6.0
0.5.9
0.5.8
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.44
0.4.43
0.4.42
0.4.41
0.4.40
0.4.39
0.4.38
0.4.37
0.4.36
0.4.35
0.4.34
0.4.33
0.4.32
0.4.30
0.4.29
0.4.28
0.4.27
0.4.26
0.4.25
0.4.24
0.4.23
0.4.22
0.4.21
0.4.20
0.4.19
0.4.18
0.4.17
0.4.16
0.4.15
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.0
0.2.0
0.1.0
AI code archaeology
Current section
Files
Jump to
Current section
Files
lib/ai/tools/file/notes.ex
defmodule AI.Tools.File.Notes do
@behaviour AI.Tools
@impl AI.Tools
def async?, do: true
@impl AI.Tools
def is_available?, do: Store.get_project() != {:error, :project_not_set}
@impl AI.Tools
def ui_note_on_request(_args), do: nil
@impl AI.Tools
def ui_note_on_result(_args, _result), do: nil
@impl AI.Tools
def tool_call_failure_message(_args, _reason), do: :default
@impl AI.Tools
def read_args(%{"file" => file}), do: {:ok, %{"file" => file}}
def read_args(%{"file_path" => file}), do: {:ok, %{"file" => file}}
def read_args(_args), do: AI.Tools.required_arg_error("file")
@impl AI.Tools
def spec() do
%{
type: "function",
function: %{
name: "file_notes_tool",
description: """
Returns the indexed summary of the specified file, or indicates that
the file exists but has not been indexed yet. This is often MUCH more
useful than the raw file contents, especially if the file may be large
and you need only a high-level understanding of the file's purpose,
behaviour, and linkage to other files.
Use this before using the file_contents_tool to avoid pulling in
unnecessary content into your context window.
Scope: this tool only works on *indexed* source files. Gitignored
paths (e.g. `scratch/` notes) are not indexed, but the tool will still
confirm that such a file exists in the source repo if you're in a
worktree session, and it will point you at file_contents_tool for
actually reading the contents.
""",
parameters: %{
additionalProperties: false,
type: "object",
required: ["file"],
properties: %{
file: %{
type: "string",
description: """
The absolute file path to the code file in the project.
"""
}
}
}
}
}
end
@impl AI.Tools
def call(args) do
with {:ok, file} <- Map.fetch(args, "file"),
{:ok, project} <- Store.get_project(),
{:ok, resolved} <- Util.find_file_within_root(file, project.source_root) do
# Build an entry key for this file path. The entry may or may not have
# indexed data on disk - we return what we have either way.
entry = Store.Project.Entry.new_from_file_path(project, resolved)
summary = read_or_shim(fn -> Store.Project.Entry.read_summary(entry) end)
{:ok, format_notes(resolved, summary)}
else
{:error, :project_not_set} ->
{:error, "This project has not yet been indexed by the user."}
{:error, :enoent} ->
handle_enoent(args)
:error ->
{:error, "Missing required parameter: file."}
end
end
# When the file isn't under the current project root, try the source-fallback
# path. If it resolves (gitignored file present in the original source repo
# but not in the worktree), return a stub notes response that acknowledges
# existence and points the LLM at file_contents_tool for content. Otherwise
# fall back to a friendlier error that mentions file_contents_tool as the
# canonical way to read unindexed paths.
defp handle_enoent(args) do
file = Map.get(args, "file", "")
case AI.Tools.resolve_source_fallback_path(file) do
{:ok, source_path} ->
{:ok, format_gitignored_notes(source_path)}
_ ->
{:error,
"""
File path not found in the current project root: #{file}
If this is a path you know exists but is not indexed (e.g. a
gitignored file under `scratch/` or similar), use file_contents_tool
instead - it reads files by path regardless of index status, and in
a worktree session it will fall back to the original source repo
for gitignored files.
"""}
end
end
defp format_gitignored_notes(source_path) do
"""
# File
`#{source_path}`
# Summary
(not indexed - this file is gitignored and lives in the source repo,
not the current worktree)
# Reading the contents
Use `file_contents_tool` with the same path you used here. In a worktree
session it will automatically read this gitignored file from the source
repo via source-fallback.
"""
end
# Returns indexed data if available, otherwise a placeholder indicating the
# file hasn't been indexed yet.
defp read_or_shim(reader) do
case reader.() do
{:ok, content} -> content
{:error, _} -> "(not indexed)"
end
end
defp format_notes(file, summary) do
"""
# File
`#{file}`
# Summary
#{summary}
"""
end
end