Rulvar API reference / @rulvar/rulvar / ResearchAgentProfileOptions
Interface: ResearchAgentProfileOptions
Defined in: packages/core/dist/index.d.ts
Options of researchAgentProfile: the toolset knobs plus template overrides.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
description? | string | Advertised profile description; the template provides a default. | - | packages/core/dist/index.d.ts |
evidenceContract? | EvidenceContract | The declared evidence floor of the task (RV303), passed through to AgentProfile.evidenceContract so preflight can compare it against the profile's tool budget and warn tool-cap-below-evidence-floor before any paid call. | - | packages/core/dist/index.d.ts |
extraTools? | ToolDef<SchemaSpec<unknown>>[] | Extra tools appended after the research toolset. | - | packages/core/dist/index.d.ts |
ignore? | string[] | Extra ignored basenames (files and directories), merged over the always-on defaults '.git' and 'node_modules'. | RepositoryResearchToolsetOptions.ignore | packages/core/dist/index.d.ts |
includeHidden? | boolean | Walk dot-entries too; default false. | RepositoryResearchToolsetOptions.includeHidden | packages/core/dist/index.d.ts |
limits? | UsageLimits | Per-key overrides over RESEARCH_PROFILE_LIMITS. | - | packages/core/dist/index.d.ts |
maxFileBytes? | number | Files larger than this many bytes are refused; default 262144. | RepositoryResearchToolsetOptions.maxFileBytes | packages/core/dist/index.d.ts |
maxScannedFiles? | number | Walk ceiling per call (files visited); default 20000. | RepositoryResearchToolsetOptions.maxScannedFiles | packages/core/dist/index.d.ts |
pageSize? | number | Rows per list/search/evidence page; default 50. | RepositoryResearchToolsetOptions.pageSize | packages/core/dist/index.d.ts |
readPageChars? | number | Content budget of one read_file page in characters; default 4000. | RepositoryResearchToolsetOptions.readPageChars | packages/core/dist/index.d.ts |
root | string | The confining directory root; everything resolves under it. | RepositoryResearchToolsetOptions.root | packages/core/dist/index.d.ts |