Graphorin API reference v0.4.0

---

Graphorin API reference / @graphorin/tools / code-mode / CodeApiProjection

Interface: CodeApiProjection

Defined in: packages/tools/src/code-mode/project.ts:40

The projected code API for a set of tools.

Properties

Property	Modifier	Type	Description	Defined in
catalogue	readonly	string	Compact catalogue (name + one-line description, grouped by source). Cheap enough to embed in a tool description.	packages/tools/src/code-mode/project.ts:47
names	readonly	readonly string[]	Every callable tool name, in registration order.	packages/tools/src/code-mode/project.ts:42

Methods

search()

search(query, limit?): string;

Defined in: packages/tools/src/code-mode/project.ts:56

Signature blocks for tools whose name or description contains query (case-insensitive substring), capped at limit (default 10).

Parameters

Parameter	Type
query	string
limit?	number

Returns

string

---

signatureFor()

signatureFor(name): string | undefined;

Defined in: packages/tools/src/code-mode/project.ts:49

Full signature block for one tool, or undefined if unknown.

Parameters

Parameter	Type
name	string

Returns

string | undefined

---

signaturesFor()

signaturesFor(names): string;

Defined in: packages/tools/src/code-mode/project.ts:51

Signature blocks for the given names (unknown names skipped).

Parameters

Parameter	Type
names	readonly string[]

Returns

string