Skip to main content

Class: ManageGraphTool

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:33

Tool available only to supervisor nodes in hierarchical strategies. Enables supervisors to structurally modify the running mission graph.

Implements​

Constructors​

Constructor​

new ManageGraphTool(): ManageGraphTool

Returns​

ManageGraphTool

Properties​

category​

readonly category: "orchestration" = 'orchestration'

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:39

Optional

Optional. A category or group to which this tool belongs (e.g., "data_analysis", "communication", "file_system", "image_generation"). This is useful for organizing tools, for filtering in UIs or registries, and potentially for aiding an LLM in selecting from a large set of tools.

Implementation of​

ITool.category

description​

readonly description: "Add, remove, or reassign agents in the running mission. Only available to supervisor agents. Use to spawn new workers, remove underperforming agents, reassign roles, add tools, or fork execution branches." = 'Add, remove, or reassign agents in the running mission. Only available to supervisor agents. Use to spawn new workers, remove underperforming agents, reassign roles, add tools, or fork execution branches.'

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:37

A detailed, natural language description of what the tool does, its primary purpose, typical use cases, and any important considerations or limitations for its use. This description is critical for an LLM to understand the tool's capabilities and make informed decisions about when and how to invoke it. It should be comprehensive enough for the LLM to grasp the tool's semantics.

Implementation of​

ITool.description

displayName​

readonly displayName: "Manage Graph" = 'Manage Graph'

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:36

A concise, human-readable title or display name for the tool. Used in user interfaces, logs, or when presenting tool options to developers or users.

Example​

"Web Search Engine", "Advanced Python Code Interpreter"

Implementation of​

ITool.displayName

hasSideEffects​

readonly hasSideEffects: true = true

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:40

Optional

Optional. Indicates if the tool might have side effects on external systems (e.g., writing to a database, sending an email, making a purchase, modifying a file). Defaults to false if not specified. LLMs or orchestrators might handle tools with side effects with greater caution, potentially requiring explicit user confirmation.

Implementation of​

ITool.hasSideEffects

id​

readonly id: "com.framers.orchestration.manage-graph" = 'com.framers.orchestration.manage-graph'

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:34

A globally unique identifier for this specific tool (e.g., "web-search-engine-v1.2", "stock-price-fetcher"). This ID is used for internal registration, management, and precise identification. It's recommended to use a namespaced, versioned format (e.g., vendor-toolname-version).

Implementation of​

ITool.id

inputSchema​

readonly inputSchema: JSONSchemaObject

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:43

The JSON schema defining the structure, types, and constraints of the input arguments object that this tool expects. This schema is used by:

  1. LLMs: To construct valid argument objects when requesting a tool call.
  2. ToolExecutor: For validating the arguments before invoking the tool's execute method. It should follow the JSON Schema specification.

See​

https://json-schema.org/

Implementation of​

ITool.inputSchema

name​

readonly name: "manage_graph" = 'manage_graph'

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:35

The functional name of the tool, as it should be presented to and used by an LLM in a tool call request (e.g., "searchWeb", "executePythonCode", "getWeatherForecast"). This name must be unique among the set of tools made available to a given GMI/LLM at any time. It should be concise, descriptive, and typically in camelCase or snake_case.

Implementation of​

ITool.name

outputSchema​

readonly outputSchema: JSONSchemaObject

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:63

Optional

Optional. The JSON schema defining the structure and types of the output object that this tool will produce upon successful execution. Providing an output schema helps in validating the tool's output, provides clarity for consumers of the tool's result (including other tools or the GMI), and can aid the LLM in understanding what to expect back from the tool.

Implementation of​

ITool.outputSchema

requiredPermissions​

readonly requiredPermissions: string[]

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:41

Methods​

execute()​

execute(_context, args): Promise<ToolExecutionResult<ManageGraphOutput>>

Defined in: packages/agentos/src/orchestration/tools/ManageGraphTool.ts:71

Async

Executes the core logic of the tool with the provided arguments and execution context. This method is asynchronous and should encapsulate the tool's primary functionality. Implementations should handle their own internal errors gracefully and package them into the ToolExecutionResult object.

Parameters​

_context​

ToolExecutionContext

args​

ManageGraphInput

The input arguments for the tool. These arguments are expected to have been validated against the tool's inputSchema by the calling system (e.g., ToolExecutor).

Returns​

Promise<ToolExecutionResult<ManageGraphOutput>>

A promise that resolves with a ToolExecutionResult object, which contains the success status, the output data (if successful), or an error message (if failed).

Throws​

While tools should ideally capture errors and return them in ToolExecutionResult.error, critical, unrecoverable, or unexpected system-level failures during execution might still result in a thrown exception. The ToolExecutor should be prepared to catch these.

Implementation of​

ITool.execute