Answers from the index

search_code_patterns

Finds how this codebase does a thing, by meaning rather than by name. Describe the concept ("cache a validated config and log the failure"), not the identifier. Returns whole declarations with the documentation written for them, as data.found, with notes saying where the answer came from and, when nothing is found, whether nothing matched or nothing is indexed. A declaration a developer documented ranks above an undocumented one of similar score, because its text says what it does rather than merely what it is called. Narrow with a tag when the concept is broad.

read-only · every call adds · stays on this machine.

Parameter Type Required Default Description
query string yes — The concept to look for, in natural language, in any language the codebase's comments are written in.
tag string? — null Narrows the answer to one tag: test, dto, di, error-handling, caching, logging, persistence, http, messaging, validation, async, cancellation. Empty — every tag.
limit integer — 5 Maximum results to return.
JSON Schema
{
  "type": "object",
  "properties": {
    "query": {
      "description": "The concept to look for, in natural language, in any language the codebase\u0027s comments are written in.",
      "type": "string"
    },
    "tag": {
      "description": "Narrows the answer to one tag: test, dto, di, error-handling, caching, logging, persistence, http, messaging, validation, async, cancellation. Empty \u2014 every tag.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "limit": {
      "description": "Maximum results to return.",
      "type": "integer",
      "default": 5
    }
  },
  "required": [
    "query"
  ]
}

get_di_conventions

Shows how this codebase registers a service: the registrations of the named contract, the module methods that own them, and the lifetimes used across the codebase. For a contract nothing registers yet, answers with how everything else is registered, which is the convention a new registration should follow.

read-only · every call adds · stays on this machine.

Parameter Type Required Default Description
interfaceName string yes — Interface or service type name, with or without its namespace.
limit integer — 10 Maximum results to return.
JSON Schema
{
  "type": "object",
  "properties": {
    "interfaceName": {
      "description": "Interface or service type name, with or without its namespace.",
      "type": "string"
    },
    "limit": {
      "description": "Maximum results to return.",
      "type": "integer",
      "default": 10
    }
  },
  "required": [
    "interfaceName"
  ]
}

get_guidelines

The rules this codebase is written by: how it is layered, how a type is shaped, how failure is reported, how members are named and documented. Read it before writing or rewriting anything for this codebase. Ask it, not search_code_patterns, whenever the question is how code should be written rather than what it does: the index holds what declarations do, and no declaration documents how to name a variable. The rules are data.guidelines, as written. When the codebase keeps no such file, the answer says so rather than inventing rules. With a topic it answers with the rules that topic is about, each with the build check that holds it where one does, so what the compiler will catch is told apart from what only review will; without one it answers with the whole document. Every answer names the file the rules were read from.

read-only · every call adds · stays on this machine.

Parameter Type Required Default Description
topic string? — null What the question is about, in words — "naming a local", "how failure is reported", "where a registration goes". Matched by meaning against the written rules, so a question in another language is understood. Empty — the whole document, which is what to ask for before writing code.
JSON Schema
{
  "type": "object",
  "properties": {
    "topic": {
      "description": "What the question is about, in words \u2014 \u0022naming a local\u0022, \u0022how failure is reported\u0022, \u0022where a registration goes\u0022. Matched by meaning against the written rules, so a question in another language is understood. Empty \u2014 the whole document, which is what to ask for before writing code.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  }
}

get_dto_format

The written contract style of this codebase, with real declarations from it that follow the style. Use before writing a DTO, a request or a result type.

read-only · every call adds · stays on this machine.

Takes no parameters.

JSON Schema
{
  "type": "object",
  "properties": {}
}