Add doc query tool requirement
This commit is contained in:
32
NEW_FEAT_DOC_QUERY.md
Normal file
32
NEW_FEAT_DOC_QUERY.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# NEW_FEAT — Document Query Tool
|
||||
|
||||
## Summary
|
||||
Add a tool to retrieve documentation files based on scope, topic, and keyword.
|
||||
|
||||
## Tool
|
||||
`get_docs(scope, topic, keyword)`
|
||||
|
||||
### Parameters
|
||||
- **scope**: enum `organization | department | team | agent`
|
||||
- **topic**: enum `docs | notes | knowledge | rules | lessons | workflows`
|
||||
- **keyword**: string (supports regular expressions)
|
||||
|
||||
## Behavior
|
||||
- Search matching files under `${openclaw dir}/yonexus/organizations/...` based on the given scope/topic.
|
||||
- `keyword` is applied to filenames (regex supported).
|
||||
- Output grouped by scope in the following format:
|
||||
```
|
||||
----ORG
|
||||
<file list>
|
||||
----DEPT
|
||||
<file list>
|
||||
----TEAM
|
||||
<file list>
|
||||
----AGENT
|
||||
<file list>
|
||||
```
|
||||
- If no match in a group, output the header with no files beneath.
|
||||
|
||||
## Notes
|
||||
- Search should be read-only.
|
||||
- Pattern errors should return a structured error (invalid regex).
|
||||
Reference in New Issue
Block a user