orxtra v0.13.0 /tool.src.orxtra.tool._params
On this page

Strict pydantic input models (extra=forbid, no coercion) for every built-in tool's parameters: read/write/edit/git/http/notepad and the task-lifecycle tools (start_task, create_task, create_workflow, create_wait_for, etc.).

#tool.src.orxtra.tool._params

#tool.src.orxtra.tool._params

Pydantic input models for all tool parameter schemas.

Each model corresponds to a tool's validated input. Models use ConfigDict(strict=True, extra="forbid") to enforce exact schema adherence -- no coercion, no extra fields.

#ReadParams

ReadParams
FieldTypeDefault
pathstr
offset`intNone`Field(default=None, ge=1)
limit`intNone`Field(default=None, ge=1)
full`boolNone`None

#ListDirParams

ListDirParams
FieldTypeDefault
pathstr
recursive`boolNone`None
pattern`strNone`None
max_results`intNone`Field(default=None, ge=1)

#GlobParams

GlobParams
FieldTypeDefault
patternstr
path`strNone`None
max_results`intNone`Field(default=None, ge=1)

#GrepParams

GrepParams
FieldTypeDefault
patternstr
path`strNone`None
case_sensitive`boolNone`None
context_lines`intNone`Field(default=None, ge=0)
max_results`intNone`Field(default=None, ge=1)
include`strNone`None
mode`strNone``Field(default=None, pattern='^(contentfiles_onlycount)$')`

#StatParams

StatParams
FieldTypeDefault
pathstr

#DiffParams

DiffParams
FieldTypeDefault
path_astr
path_bstr

#WriteParams

WriteParams
FieldTypeDefault
pathstr
contentstr
create_dirs`boolNone`None

#EditParams

EditParams
FieldTypeDefault
pathstr
old_stringstr
new_stringstr
replace_all`boolNone`None

#MultiEditItem

MultiEditItem
FieldTypeDefault
filestr
old_stringstr
new_stringstr

#MultiEditParams

MultiEditParams
FieldTypeDefault
editslist[MultiEditItem]Field(min_length=1)

#MkdirParams

MkdirParams
FieldTypeDefault
pathstr

#MoveParams

MoveParams
FieldTypeDefault
sourcestr
destinationstr

#CopyParams

CopyParams
FieldTypeDefault
sourcestr
destinationstr

#DeleteParams

DeleteParams
FieldTypeDefault
pathstr
descriptionstr
recursivebool

#SetExecutableParams

SetExecutableParams
FieldTypeDefault
pathstr

#NotepadParams

NotepadParams
FieldTypeDefault
typestr`Field(pattern='^(learningdecisionissue)$')`
textstrField(min_length=1)

#GitParams

GitParams
FieldTypeDefault
subcommandstr
args`list[str]None`None

#StartTaskParams

StartTaskParams
FieldTypeDefault
task_idstr

#EndTaskParams

EndTaskParams
FieldTypeDefault
messagestr

#CreateTaskParams

CreateTaskParams
FieldTypeDefault
namestr
agentstr
task_promptstr
timeoutintField(ge=1)
context_refinementbool
prechecks`list[Any]None`None
postchecks`list[Any]None`None
variable_values`dict[str, Any]None`None
budget`floatNone`Field(default=None, ge=0)
write_paths`list[str]None`None
category`strNone`None
retry`intNone`Field(default=None, ge=0)
retry_resume`boolNone`None
retry_inject_failure`boolNone`None
depends_on`list[str]None`None

#CreateWorkflowParams

CreateWorkflowParams
FieldTypeDefault
namestr
descriptionstr
goalslist[str]Field(min_length=1)
postchecks`list[Any]None`None
budget`floatNone`Field(default=None, ge=0)

#CreateWaitForParams

CreateWaitForParams
FieldTypeDefault
namestr
event_namestr
timeoutintField(ge=1)
depends_on`list[str]None`None

#AwaitTaskParams

AwaitTaskParams
FieldTypeDefault
task_idstr

#ExecBaseParams

ExecBaseParams
FieldTypeDefault
args`list[str]None`None
timeout`intNone`Field(default=None, ge=1)

#ShellBaseParams

ShellBaseParams
FieldTypeDefault
commandstr
timeout`intNone`Field(default=None, ge=1)

#HttpBaseParams

HttpBaseParams
FieldTypeDefault
methodstr
urlstr
headers`dict[str, str]None`None
body`strNone`None
timeout`intNone`Field(default=None, ge=1)

#HttpFullParams

HttpFullParams
FieldTypeDefault
methodLiteral['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD']
urlstr
headers`dict[str, str]None`None
body`strNone`None
timeout`intNone`Field(default=None, ge=1)

#HttpConsultParams

HttpConsultParams
FieldTypeDefault
methodLiteral['GET', 'HEAD']
urlstr
headers`dict[str, str]None`None
body`strNone`None
timeout`intNone`Field(default=None, ge=1)

#ConsultParams

ConsultParams
FieldTypeDefault
agentstr
questionstrField(min_length=1)
variable_values`dict[str, str]None`None
Search