ATOMSATOMSDocs
Tool Reference

atoms_search

Full-text search across items in a project

Perform a full-text search across all items in a project. Searches across title, body, and summary fields, with results ranked by relevance.

Parameters

ParameterTypeRequiredDescription
project_idstring (UUID)YesThe project to search in
querystringYesSearch text (1-1000 characters)
typestringNoFilter results by item type: requirement, test-case, note, or table
limitnumberNoMax results (1-100). Default: 25

Example Response

{
  "status": "success",
  "data": [
    {
      "id": "REQ-045",
      "type": "requirement",
      "title": "Braking system shall engage within 200ms",
      "summary": "Emergency braking response time requirement",
      "domains": ["safety"],
      "level": "System"
    },
    {
      "id": "TC-078",
      "type": "test-case",
      "title": "Measure braking response latency under load",
      "summary": "Verify braking engages within 200ms at full vehicle load",
      "domains": ["safety"],
      "level": "System"
    }
  ],
  "meta": {
    "total_count": 2,
    "limit": 25
  }
}

Notes

  • This tool is read-only and does not modify any data (readOnlyHint: true).
  • The search matches against title, body, and summary fields simultaneously.
  • Results are ranked by relevance to the query, with the best matches returned first.
  • Use the optional type filter to scope results to a specific item type, for example only requirement items.
  • For browsing without a search term, use atoms_list_items instead.

On this page