Skip to content

chore: Warn fs_read_file output is not visible to the user #803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rxgrant wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −1
Open

chore: Warn fs_read_file output is not visible to the user #803

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .jp/mcp/tools/fs/read_file.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ enable = false
run = "unattended"
source = "local"
command = "just serve-tools {{context}} {{tool}}"
summary = "Read the contents of a file in the project's local filesystem."
summary = """
Read the contents of a file in the project's local filesystem. Do not use it to
show file contents to the user; they will not see the result. Call
`describe_tools` for examples.
"""
description = """
You can use `fs_grep_files` to search for specific patterns in the file
contents, before reading the entire contents of a specific file using this tool.
Expand All @@ -19,6 +23,14 @@ Read a specific line range:
```json
{"path": "crates/jp_llm/src/tool.rs", "start_line": 100, "end_line": 150}
```

Do NOT use this tool to show file contents to the user. They only see that the
tool was called, not its output. To show file contents, write your own
quotation block. For example, this shows the user nothing:

> I can see the culprit. In .jp/config.toml the tool is defined as:
>
> Calling tool fs_read_file(path: ".jp/config.toml", start_line: 240, end_line: 246)
"""

[conversation.tools.fs_read_file.style]
Expand Down
Loading