search
tools/call
Search the workspace as the Specify search box does, with this key's own access: tasks (by title, description, next action, tags or key), projects, project docs (briefs and wiki pages), canvases, memory, files and people, ranked together. Agent sessions are not searched here: use session_list. Words in double quotes must appear together, in that order. A group is partial when more of its type match than it shows: search that type alone (types) with a limit up to 50, then pass the returned nextCursor to read the next page until it is null. Types this key cannot read are listed in omitted, and types searched only in part with no match in what was read are listed in limited (more may match). A task result's id is its taskId for task_get, a document result's id is the documentId for documents_execute, and a memory result's id is the memoryId for memory_history. href is the result's path in the Specify app.
Scopes
Each type needs the scope its own tool needs, and a type the key lacks it for is listed in omitted: read:projects for tasks, projects and documents (documents also need the editor open), read:memory for memory, read:files for files and read:work for people. Sessions are never searched here (use session_list); session asked for is always in omitted. Results are only what the key could open itself.
Inputs
- querystringRequired
- Words to find, 1 to 100 characters. "Quoted words" must appear together, in order
- typesstring
- Comma-separated types to search: task, project, document, canvas, memory, file, person. Omit for every type
- limitnumber
- Results per type: up to 8 when searching several types (default 5), up to 50 when searching one
- includeArchivedboolean
- Also find archived tasks and projects
- cursorstring
- The nextCursor from the previous call of this same one-type search, for its next page
Returns
Groups of ranked results by type, each with id, title, subtitle, href, a short preview and partial, plus the types omitted for missing access. A call returns content[0].text with the JSON result and structuredContent.result with the same value.
Listed when
The key has agent access and every scope the tool needs.