Import any tool set and spread it into your agent’s tools object. Each tool set is a plain object whose keys are tool names — you can spread multiple sets together, or use pick / omit to narrow them.
import {
guildTools,
userInterfaceTools,
pick,
omit,
} from "@guildai/agents-sdk";
import { gitHubTools } from "@guildai-services/guildai~github";
const tools = {
...guildTools,
...userInterfaceTools,
...pick(gitHubTools, ["github_repos_get", "github_pulls_list"]),
};
guildTools also enables task.guild.
import { guildTools } from "@guildai/agents-sdk";
const tools = { ...guildTools };
guild_{endpoint} where {endpoint} is the GuildService method name. For example, get_workspace_contexts becomes guild_get_workspace_contexts.
Most guild tools are synchronous: the runtime calls the Guild API and returns the result immediately. A few are hooks — they may suspend the agent while waiting for user action or an external callback:
| Hook tool | What it waits for |
|---|
guild_agent_install_request | User approves agent installation into the workspace |
guild_credentials_request | User completes an OAuth flow for a third-party service |
guild_experimental_fetch_async | HTTP response arrives asynchronously |
guild_sleep | Timer expires |
onToolResults / automatic resumption continues where you left off.
Full endpoint listing
All 55 guild_* tools correspond 1-to-1 with the GuildService methods documented in the Task object — task.guild section, organized into these groups:
| Group | Example tools |
|---|
| Current user | guild_get_me, guild_get_my_workspaces, guild_get_my_organizations |
| Users | guild_search_users, guild_get_user |
| Agents | guild_list_agents, guild_create_agent, guild_search_agent, guild_get_agent_code |
| Agent likes | guild_create_agent_like, guild_list_agent_likers |
| Organizations | guild_get_organization, guild_get_organization_workspaces |
| Workspaces | guild_get_workspace, guild_get_workspace_contexts, guild_create_workspace_context |
| Triggers | guild_create_workspace_trigger, guild_activate_trigger, guild_deactivate_trigger |
| Sessions & tasks | guild_get_session, guild_get_task_workspace_agents |
| LLM usage | guild_get_daily_llm_usage, guild_get_hourly_llm_usage |
| Credentials & install | guild_credentials_request, guild_agent_install_request |
| Flow control & HTTP | guild_sleep, guild_experimental_fetch, guild_experimental_fetch_async |
task.ui.
| Tool | Description |
|---|
ui_prompt | Ask the user a question and block until they respond (hook — suspends execution) |
ui_notify | Fire-and-forget notification, progress update, or error message |
ui_ping | Health-check the UI surface (mostly for testing) |
import { userInterfaceTools } from "@guildai/agents-sdk";
llmAgent automatically includes userInterfaceTools — you don’t need to add
them manually. Include them explicitly only in coded agents that need user
interaction.
| Tool | Description |
|---|
console_log | Log a message at a given level (debug, info, warn, error) |
import { consoleTools } from "@guildai/agents-sdk";
task.console is always available regardless of whether consoleTools is included. Include consoleTools in llmAgent definitions to give the LLM access to debug logging.
An explicit empty tool set. Useful when an agent deliberately needs no tools — makes the intent clear instead of passing {}.
import { noTools } from "@guildai/agents-sdk";
export default agent({
description: "Returns the input unchanged.",
inputSchema,
outputSchema,
tools: noTools,
run: async (input) => input,
});
Service integrations
Third-party service tools are imported from their own @guildai-services/* packages. Add them to dependencies in your agent’s package.json.
| Service | Import |
|---|
| GitHub | import { gitHubTools } from "@guildai-services/guildai~github" |
| Slack | import { slackTools } from "@guildai-services/guildai~slack" |
| Jira | import { jiraTools } from "@guildai-services/guildai~jira" |
| Bitbucket | import { bitbucketTools } from "@guildai-services/guildai~bitbucket" |
| Azure DevOps | import { azureDevOpsTools } from "@guildai-services/guildai~azure-devops" |
| Confluence | import { confluenceTools } from "@guildai-services/guildai~confluence" |
| Figma | import { figmaTools } from "@guildai-services/guildai~figma" |
| Cypress | import { cypressTools } from "@guildai-services/guildai~cypress" |
| New Relic | import { newrelicTools } from "@guildai-services/guildai~newrelic" |
| TestRail | import { testrailTools } from "@guildai-services/guildai~testrail" |
pick to cherry-pick or omit to exclude specific tools from a set:
import {
pick,
omit,
guildTools,
userInterfaceTools,
} from "@guildai/agents-sdk";
import { gitHubTools } from "@guildai-services/guildai~github";
// Include only what you need
const tools = {
...userInterfaceTools,
...pick(gitHubTools, [
"github_repos_get",
"github_pulls_list",
"github_issues_create_comment",
]),
};
// Or exclude what you don't want
const trimmedGuild = omit(guildTools, [
"guild_generate_agent_avatar",
"guild_create_agent_like",
"guild_delete_agent_like",
]);
