27 lines (23 loc) · 32.9 KB

ToolMetadata

The manifest for a tool that can be used to augment Glean Assistant.

Fields

Field	Type	Required	Description	Example
`type`	models.ToolMetadataType	✔️	The type of tool.
`name`	str	✔️	Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool.
`display_name`	str	✔️	Human understandable name of the tool. Max 50 characters.
`tool_id`	Optional[str]	➖	An opaque id which is unique identifier for the tool.
`display_description`	str	✔️	Description of the tool meant for a human.
`logo_url`	Optional[str]	➖	URL used to fetch the logo.
`object_name`	Optional[str]	➖	Name of the generated object. This will be used to indicate to the end user what the generated object contains.	[ "HR ticket", "Email", "Chat message" ]
`knowledge_type`	Optional[models.KnowledgeType]	➖	Indicates the kind of knowledge a tool would access or modify.
`created_by`	Optional[models.PersonObject]	➖	N/A
`last_updated_by`	Optional[models.PersonObject]	➖	N/A
`created_at`	date	➖	The time the tool was created in ISO format (ISO 8601)
`last_updated_at`	date	➖	The time the tool was last updated in ISO format (ISO 8601)
`write_action_type`	Optional[models.WriteActionType]	➖	Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. MCP - Send a tools/call request to an MCP server to execute the action.
`auth_type`	Optional[models.AuthType]	➖	The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation.
`auth`	Optional[models.AuthConfig]	➖	Config for tool's authentication method.
`permissions`	Optional[models.ObjectPermissions]	➖	N/A
`usage_instructions`	Optional[str]	➖	Usage instructions for the LLM to use this action.
`is_setup_finished`	Optional[bool]	➖	Whether this action has been fully configured and validated.