Packages
fnord
0.9.38
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/contents.ex
defmodule AI.Tools.File.Contents do
@behaviour AI.Tools
@impl AI.Tools
def async?, do: true
@impl AI.Tools
def is_available?, do: true
@impl AI.Tools
def ui_note_on_request(%{"line_numbers" => true} = args) do
{"Read +ln", ui_note_file_ref(args)}
end
def ui_note_on_request(args) do
{"Read -ln", ui_note_file_ref(args)}
end
defp ui_note_file_ref(%{"file" => file} = args) do
display = AI.Tools.display_path(file)
start_line = Map.get(args, "start_line", 1)
end_line = Map.get(args, "end_line", -1)
case {start_line, end_line} do
{1, -1} -> "#{display} (full)"
{s, e} -> "#{display}:#{s}...#{e}"
end
end
defp ui_note_file_ref(_), do: "invalid args :/"
@impl AI.Tools
def ui_note_on_result(_args, _result), do: nil
@impl AI.Tools
def tool_call_failure_message(_args, _result), do: :default
@impl AI.Tools
def read_args(args) do
case args do
%{"file" => _file} -> {:ok, args}
_ -> {:error, :missing_argument, "file"}
end
end
@impl AI.Tools
def spec() do
%{
type: "function",
name: "file_contents_tool",
description: """
Display the contents of a file in the project. Note that this retrieves
the ENTIRE file. If the file is large, this may fail due to limits on
the size of messages, or it may pull so much content into your context
window that you forget the user's prompt or begin hallucinating
responses. If you only need to learn specific facts or extract a
section of code, use the file_info_tool to preserve your context
window.
This tool reads files by path regardless of index status. It works
for indexed source files AND for files that are not in the index -
including gitignored paths like `scratch/` notes. In a worktree
session, if the file isn't present in the worktree but exists as a
gitignored file in the original source repo, this tool will fall
back to reading it from there (and annotate the result with a note
explaining where it came from). If file_notes_tool, file_search_tool,
or file_list_tool can't find a path you know exists, reach for this
tool - it will read it directly.
Note that this tool ONLY shows the current version of the file on the
currently checked-out branch. If you need to see the contents of the
file on a different branch (or for files that only exist on that
branch), you must use your git tools to retrieve that version of the
file.
""",
parameters: %{
type: "object",
required: ["file"],
properties: %{
file: %{
type: "string",
description: """
The file whose contents you wish to review. Typically the
complete path provided by the file_search_tool or file_list_tool,
but any valid path within the project will work - including
unindexed and gitignored paths.
"""
},
line_numbers: %{
type: "boolean",
description: """
If true (default), prefix each line with a hashline identifier:
`<line_number>:<content_hash>`, where the content hash is a 2-character
hex fingerprint of the line's content.
""",
default: true
},
start_line: %{
type: "integer",
description: """
The 1-based line number to start from. If not provided, defaults
to the first line. If start_line is outside of the range of lines
in the file, it will be ignored and the first line of the file
will be used.
""",
default: 1
},
end_line: %{
type: "integer",
description: """
The 1-based line number to end at. If not provided, defaults to
the last line of the file. If end_line is outside of the range of
lines in the file, it will be ignored and the last line of the
file will be used.
""",
default: nil
}
}
}
}
end
@impl AI.Tools
def call(%{"file" => file} = args) do
line_numbers = Map.get(args, "line_numbers", true)
start_line = Map.get(args, "start_line", 1)
end_line = Map.get(args, "end_line", nil)
case AI.Tools.get_file_contents_with_origin(file) do
{:ok, content} ->
ExternalConfigs.Injector.maybe_inject_for_path(file)
output =
content
|> maybe_number_lines(line_numbers)
|> maybe_splice_lines(start_line, end_line)
|> wrap_content(file)
{:ok, output}
{:source_fallback, source_path, content} ->
ExternalConfigs.Injector.maybe_inject_for_path(file)
output =
content
|> maybe_number_lines(line_numbers)
|> maybe_splice_lines(start_line, end_line)
|> wrap_content_with_source_fallback(file, source_path)
{:ok, output}
{:error, :enoent} ->
{:error,
"""
The requested file (#{args["file"]}) does not exist.
- If the file name is correct (per the list_files_tool), verify the path using the search or the file listing tool.
- It may have been added since the most recent reindexing of the project.
- If the file is only present in a topic branch that has not yet been merged, it may not be visible to this tool.
"""}
{:error, reason} ->
{:error, reason}
end
end
defp wrap_content(text, file) do
backup_note =
case Services.BackupFile.describe_backup(file) do
nil -> ""
desc -> "#{desc}\n"
end
"""
[file_contents_tool] Contents of #{file}:
Note: Lines are prefixed with `<line_number>:<content_hash>` for identification.
#{backup_note}```
#{text}
```
"""
end
# Wraps the content with a banner explaining that the file came from the
# source repo via the gitignore source-fallback path, not the worktree.
# The note tells the LLM how to write back through the worktree so the
# accumulator preserves the change on merge.
defp wrap_content_with_source_fallback(text, file, source_path) do
"""
[file_contents_tool] NOTE: this file is gitignored and is not present in
the current worktree. It has been read from the source repo at:
#{source_path}
If you want to modify this file, write to its path WITHIN the worktree
(e.g. `#{file}`). The change will be tracked and copied back to the
source repo when the worktree is merged after you finalize your response.
Contents of #{file}:
Note: Lines are prefixed with `<line_number>:<content_hash>` for identification.
```
#{text}
```
"""
end
@spec maybe_splice_lines(String.t(), integer() | nil, integer() | nil) :: String.t()
defp maybe_splice_lines(text, nil, nil), do: text
defp maybe_splice_lines(text, 1, nil), do: text
# Line numbers are 1-based, so we adjust accordingly
defp maybe_splice_lines(text, start_line, end_line) do
lines = String.split(text, "\n")
start_index = max(start_line - 1, 0)
end_index =
if end_line do
min(end_line - 1, length(lines) - 1)
else
length(lines) - 1
end
if start_index <= end_index do
lines
|> Enum.slice(start_index..end_index)
|> Enum.join("\n")
else
text
end
end
defp maybe_number_lines(text, true), do: Util.numbered_lines(text, separator: "\t")
defp maybe_number_lines(text, _), do: text
end