docs: add project to CLI examples#947
Open
blankanswer wants to merge 1 commit into
Open
Conversation
Signed-off-by: Blank_Answer <97771966+blankanswer@users.noreply.github.com>
Author
|
Looks like Could maintainers rerun the cancelled Windows job or rerun failed jobs? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Updates the README CLI examples to include the required
projectfield for project-scoped tool calls.The previous examples showed commands such as
search_graph,trace_path,query_graph, and--raw search_graphwithout aprojectvalue, which can lead toproject not found or not indexederrors when users copy the examples directly.This PR also adds a short note telling users to run
list_projectsfirst and use the returned projectnameas theprojectvalue.Closes #945.
Checklist
git commit -s) — required, CI rejects unsigned commits (DCO, see CONTRIBUTING.md)make -f Makefile.cbm test) — not run; docs-only changemake -f Makefile.cbm lint-ci) — not run; docs-only change