Guild

https://docs.guild.ai/
Admin
Guild is a platform for building and running AI agents, offering pre-built agents from a catalog and...
Tokens:70,735
Snippets:975
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run system utilities

Source: https://docs.guild.ai/cli/commands

Commands for diagnosing setup issues, installing assistant skills, and checking the CLI version.

```bash
guild doctor     # Diagnose setup issues (auth, server, workspace, git)
guild setup      # Install coding assistant skills in the current project
guild version    # Show the CLI version
```

--------------------------------

### Install and authenticate with Guild CLI

Source: https://docs.guild.ai/cli/getting-started

Install the CLI globally and authenticate your local environment.

```bash
# Install the CLI
npm i @guildai/cli -g

# Authenticate with Guild
guild auth login

# Verify
guild auth status
```

--------------------------------

### Setup Coding Assistant Skills

Source: https://docs.guild.ai/cli/introduction

Installs development skills into the project for use with coding assistants like Claude Code.

```bash
guild setup
```

--------------------------------

### Install Guild CLI

Source: https://docs.guild.ai/cli/introduction

Installs the Guild CLI globally using npm.

```bash
npm install -g @guildai/cli
```

--------------------------------

### experimental_github_installation_token

Source: https://docs.guild.ai/sdk/task-object

Mints a GitHub installation token for the current workspace.

```APIDOC
## experimental_github_installation_token

### Description
Mint a GitHub installation token for the current workspace.
```

--------------------------------

### Verify Installation

Source: https://docs.guild.ai/cli/introduction

Checks the currently installed version of the Guild CLI.

```bash
guild --version
```

--------------------------------

### Authentication and Setup Commands

Source: https://docs.guild.ai/cli/getting-started

Commands for managing user authentication, workspace selection, and environment diagnostics.

```bash
guild auth login              # Authenticate with Guild
guild auth logout             # Sign out
guild auth status             # Check authentication
guild workspace select        # Set default workspace
guild doctor                  # Check CLI setup
guild setup                   # Install coding assistant skills
```

--------------------------------

### Initialize GitHub Agent

Source: https://docs.guild.ai/integrations/github

Basic setup for an agent with access to all available GitHub tools.

```typescript
import { gitHubTools } from "@guildai-services/guildai~github"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages GitHub issues",
  tools: { ...gitHubTools },
})
```

--------------------------------

### Initialize Jira Agent

Source: https://docs.guild.ai/integrations/jira

Basic setup for an agent with full access to all Jira tools.

```typescript
import { jiraTools } from "@guildai-services/guildai~jira"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages Jira issues",
  tools: { ...jiraTools },
})
```

--------------------------------

### Example generated JSON schema

Source: https://docs.guild.ai/guide/goose-agents

A concrete example of a JSON schema derived from recipe parameters.

```json
{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "Optional message appended after the recipe's default prompt."
    },
    "parameters": {
      "type": "object",
      "properties": {
        "language": {
          "type": "string",
          "enum": ["python", "typescript"],
          "description": "Language under review"
        },
        "focus": {
          "type": "string",
          "default": "best practices",
          "description": "Review focus area"
        }
      },
      "required": ["language"],
      "additionalProperties": false
    }
  },
  "required": ["parameters"],
  "additionalProperties": false
}
```

--------------------------------

### Install MCP integration packages

Source: https://docs.guild.ai/sdk/mcp-integrations

Use npm to install scoped MCP integration packages following the @guildai-services/<owner>~<name> naming convention.

```bash
npm install --save @guildai-services/<owner>~<name>
```

```bash
npm install --save @guildai-services/attio~attio-mcp
```

--------------------------------

### Initialize Asana Agent

Source: https://docs.guild.ai/integrations/asana

Basic setup for an agent with full access to all Asana tools.

```typescript
import { AsanaTools } from "@guildai-services/cwaddingham~asana"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages Asana tasks",
  tools: { ...AsanaTools },
})
```

--------------------------------

### Initialize Attio tools in an agent

Source: https://docs.guild.ai/integrations/attio

Basic setup to provide an agent with full access to Attio CRM tools.

```typescript
import { attioTools } from "@guildai-services/guildai~attio"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that reads and updates CRM records in Attio",
  tools: { ...attioTools },
})
```

--------------------------------

### Initialize Splunk tools in an agent

Source: https://docs.guild.ai/integrations/splunk

Basic setup to provide an agent with all available Splunk tools.

```typescript
import { splunkTools } from "@guildai-services/guildai~splunk"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that searches and analyzes Splunk data",
  tools: { ...splunkTools },
})
```

--------------------------------

### agent_install_request

Source: https://docs.guild.ai/sdk/task-object

Requests the user to install another agent into the workspace.

```APIDOC
## agent_install_request

### Description
Ask the user to install another agent into the workspace.
```

--------------------------------

### Example Context Markdown

Source: https://docs.guild.ai/platform/context

A sample Markdown structure for defining project overview, repositories, and coding conventions.

```markdown
# Acme Platform

A B2B SaaS platform for inventory management. The backend is Python (FastAPI)
and the frontend is React + TypeScript. PostgreSQL is the primary database.

## Repositories

- `acme/api` — FastAPI backend
- `acme/app` — React frontend
- `acme/infra` — Terraform infrastructure

## Conventions

- Python: follow PEP 8, use type hints everywhere, prefer `ruff` for linting
- TypeScript: strict mode, functional components, no `any` types
- Git: conventional commits (`feat:`, `fix:`, `chore:`)
- PRs require at least one review before merging to `main`
```

--------------------------------

### Test Agent

Source: https://docs.guild.ai/quickstart

Commands to run an interactive test session and example output.

```bash
guild agent test
```

```text
You: Hello!
Agent: Hello! Welcome. I'm happy to help. What can I do for you today?
```

--------------------------------

### Initialize Linear tools in an agent

Source: https://docs.guild.ai/integrations/linear

Basic setup to provide an agent with full access to all available Linear tools.

```typescript
import { linearTools } from "@guildai-services/guildai~linear"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages Linear issues",
  tools: { ...linearTools },
})
```

--------------------------------

### Get version details

Source: https://docs.guild.ai/cli/skills

Retrieves detailed information for a specific skill version using its ID.

```bash
guild skill version get <version-id>
```

--------------------------------

### Initialize AWS CloudWatch Agent

Source: https://docs.guild.ai/integrations/aws-cloudwatch

Basic setup for an agent with full access to all AWS CloudWatch tools.

```typescript
import { awsCloudwatchTools } from "@guildai-services/guildai~aws-cloudwatch"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that monitors AWS CloudWatch",
  tools: { ...awsCloudwatchTools },
})
```

--------------------------------

### Verify Guild AI installation

Source: https://docs.guild.ai/cli/introduction

Run the doctor command to check authentication, connectivity, and configuration status.

```bash
guild doctor
```

--------------------------------

### List and get skill details with JSON output

Source: https://docs.guild.ai/cli/skills

Use the --json flag with skill commands to receive output in a machine-readable format.

```bash
guild skill list --json
guild skill get myorg~tone-guide --json
guild skill version list myorg~tone-guide --json
```

--------------------------------

### Create an integration via CLI

Source: https://docs.guild.ai/services/create-an-integration

Commands to initialize a new integration with specific authentication schemes.

```bash
guild integration create my-service \
  --base-url https://api.example.com \
  --auth-scheme api-key \
  --description "Connect to the Acme API"
```

```bash
guild integration create my-oauth-service \
  --base-url https://api.example.com \
  --auth-scheme oauth \
  --install-url https://example.com/oauth/authorize \
  --token-url https://example.com/oauth/token \
  --client-id <id> --client-secret <secret> \
  --scopes "read,write"
```

```bash
guild integration create my-oauth-service \
  --base-url https://api.example.com \
  --auth-scheme oauth \
  --install-url https://example.com/oauth/authorize \
  --token-url https://example.com/oauth/token \
  --client-id <id> --client-secret <secret> \
  --scopes "read,write" \
  --token-auth-method basic
```

--------------------------------

### POST /api/workspaces/{owner_name}/{workspace_name}/sessions

Source: https://docs.guild.ai/platform/triggers

Starts a new agent session by providing the session type and agent input.

```APIDOC
## POST /api/workspaces/{owner_name}/{workspace_name}/sessions

### Description
Starts a new agent session.

### Method
POST

### Endpoint
/api/workspaces/{owner_name}/{workspace_name}/sessions

### Parameters
#### Path Parameters
- **owner_name** (string) - Required - The owner of the workspace.
- **workspace_name** (string) - Required - The name of the workspace.

#### Request Body
- **session_type** (string) - Required - Must be set to "api_trigger".
- **agent_input** (object) - Required - A JSON object matching the input schema of your agent.
```

--------------------------------

### Create and version a skill via CLI

Source: https://docs.guild.ai/platform/skills

Use these commands to initialize a new skill and publish a specific version with markdown content.

```bash
# Create a skill
guild skill create tone-guide --overview "Brand voice and messaging guidelines"

# Publish a version with your markdown content
guild skill version create myorg~tone-guide \
  --version-number 1.0.0 \
  --description "Use when drafting user-facing copy or messaging" \
  --body-file tone-guide.md
```

--------------------------------

### Create Agent Project

Source: https://docs.guild.ai/quickstart

Commands to create a new directory and initialize the agent structure.

```bash
mkdir hello-agent && cd hello-agent
guild agent init --name hello-agent --template LLM
```

--------------------------------

### Fetch session sub-tasks

Source: https://docs.guild.ai/platform/triggers

Endpoint and cURL example to list sub-tasks spawned by parent agents or tool calls.

```http
GET /api/sessions/{session_id}/tasks
```

```bash
curl -X GET https://app.guild.ai/api/sessions/<session_id>/tasks \
  -u "<api_key_id>:<api_key_secret>"
```

--------------------------------

### GET /repos/{owner}/{repo}/issues/{issue_number}

Source: https://docs.guild.ai/integrations/github

Get a single issue by issue number.

```APIDOC
## GET /repos/{owner}/{repo}/issues/{issue_number}

### Description
Get a single issue by issue number.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/issues/{issue_number}

### Parameters
#### Path Parameters
- **owner** (string) - Required
- **repo** (string) - Required
- **issue_number** (integer) - Required
```

--------------------------------

### Initialize and configure agents

Source: https://docs.guild.ai/cli/commands

Commands to initialize new agents with specific templates, names, or from existing forks.

```bash
# Initialize the current directory as a new agent
guild agent init
guild agent init --name my-agent
guild agent init --name my-agent --template LLM
guild agent init --name my-agent --category development --tags "code-review,testing"
guild agent init --fork <agent-id>   # Start from an existing agent
```

--------------------------------

### View project structure

Source: https://docs.guild.ai/cli/getting-started

Standard file structure for a newly initialized agent.

```text
my-agent/
├── agent.ts          # Your agent code (edit this)
├── package.json      # Dependencies (runtime packages pre-configured)
├── tsconfig.json     # TypeScript config
├── guild.json        # Local config (managed by CLI, don't edit)
└── .gitignore
```

--------------------------------

### Guild AI doctor output example

Source: https://docs.guild.ai/cli/getting-started

Example output showing the results of the guild doctor diagnostic check.

```text
Checking Guild CLI setup...

  ✓ Authentication       Logged in
  ✓ Server               Connected to https://app.guild.ai/api (125ms)
  ✓ Global config        ~/.guild/config.json
  ✓ Default workspace    my-workspace
  - Local config         Not in an agent directory
  ✓ Git                  Installed

5 passed, 0 failed, 1 skipped
```

--------------------------------

### Initialize a new agent

Source: https://docs.guild.ai/cli/getting-started

Create a new agent directory and initialize it using the CLI prompts or flags.

```bash
mkdir my-agent && cd my-agent
guild agent init
```

```bash
guild agent init --name my-agent --template LLM --category development
```

--------------------------------

### GET /rest/api/3/project

Source: https://docs.guild.ai/integrations/jira

Retrieves a list of all projects.

```APIDOC
## GET /rest/api/3/project

### Description
Retrieves a list of all projects.

### Method
GET

### Endpoint
/rest/api/3/project
```

--------------------------------

### GET /rest/api/3/search/jql

Source: https://docs.guild.ai/integrations/jira

Searches for issues using JQL.

```APIDOC
## GET /rest/api/3/search/jql

### Description
Searches for issues using JQL.

### Method
GET

### Endpoint
/rest/api/3/search/jql
```

--------------------------------

### Manage workspaces

Source: https://docs.guild.ai/cli/commands

Commands for listing, creating, retrieving, and setting the default workspace.

```bash
guild workspace list                    # List all accessible workspaces
guild workspace create <name>           # Create a new workspace
guild workspace get <identifier>        # Get workspace details
guild workspace select                  # Set the default workspace (interactive)
guild workspace select <id-or-name>     # Set the default workspace directly
guild workspace current                 # Show current default workspace
guild workspace clear                   # Remove the default workspace setting
```

--------------------------------

### GET /rest/api/3/issue/{issueIdOrKey}

Source: https://docs.guild.ai/integrations/jira

Retrieves details of a specific issue.

```APIDOC
## GET /rest/api/3/issue/{issueIdOrKey}

### Description
Retrieves details of a specific issue.

### Method
GET

### Endpoint
/rest/api/3/issue/{issueIdOrKey}

### Parameters
#### Path Parameters
- **issueIdOrKey** (string) - Required - The ID or key of the issue.
```

--------------------------------

### Discover and manage integrations

Source: https://docs.guild.ai/cli/commands

Commands for listing, searching, and retrieving details about available integrations.

```bash
guild integration list                        # List integrations
guild integration list --search "deploy"      # Search by name or description
guild integration list --published            # Only show published integrations
guild integration search <query>              # Search integrations
guild integration search <query> --sort newest  # Sort by: updated, newest, name
guild integration search <query> --published  # Only show published integrations
guild integration search <query> --limit 10 --offset 20  # Paginate results
guild integration get <id_or_name>            # Get integration details
```

--------------------------------

### GET /rest/api/3/project/{projectIdOrKey}

Source: https://docs.guild.ai/integrations/jira

Retrieves details of a specific project.

```APIDOC
## GET /rest/api/3/project/{projectIdOrKey}

### Description
Retrieves details of a specific project.

### Method
GET

### Endpoint
/rest/api/3/project/{projectIdOrKey}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### GET /get_users

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of all users in the TestRail instance.

```APIDOC
## GET /get_users

### Description
Retrieves a list of all users in the TestRail instance.

### Method
GET

### Endpoint
/get_users
```

--------------------------------

### GET /get_current_user

Source: https://docs.guild.ai/integrations/testrail

Retrieves information about the currently authenticated user.

```APIDOC
## GET /get_current_user

### Description
Retrieves information about the currently authenticated user.

### Method
GET

### Endpoint
/get_current_user
```

--------------------------------

### GET /get_results/{test_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves results for a specific test.

```APIDOC
## GET /get_results/{test_id}

### Description
Retrieves results for a specific test.

### Method
GET

### Endpoint
/get_results/{test_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the test.
```

--------------------------------

### Create a skill via Guild CLI

Source: https://docs.guild.ai/cli/skills

Initializes a new skill package. Use the interactive mode or provide an overview directly via flags.

```bash
guild skill create <name>
```

```bash
guild skill create tone-guide --overview "Brand voice and messaging guidelines"
```

--------------------------------

### GET /get_test/{test_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific test.

```APIDOC
## GET /get_test/{test_id}

### Description
Retrieves details for a specific test.

### Method
GET

### Endpoint
/get_test/{test_id}

### Parameters
#### Path Parameters
- **test_id** (string) - Required - The ID of the test.
```

--------------------------------

### GET /get_attachment/{attachment_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a specific attachment by ID.

```APIDOC
## GET /get_attachment/{attachment_id}

### Description
Retrieves a specific attachment by ID.

### Method
GET

### Endpoint
/get_attachment/{attachment_id}

### Parameters
#### Path Parameters
- **attachment_id** (string) - Required - The ID of the attachment.
```

--------------------------------

### Manage Context Versions

Source: https://docs.guild.ai/platform/context

Commands to list available context versions or inspect a specific version.

```bash
# List all versions
guild workspace context list <workspace-id>

# Inspect a version
guild workspace context get <workspace-id> <context-id>
```

--------------------------------

### GET /get_section/{section_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific section.

```APIDOC
## GET /get_section/{section_id}

### Description
Retrieves details for a specific section.

### Method
GET

### Endpoint
/get_section/{section_id}

### Parameters
#### Path Parameters
- **section_id** (string) - Required - The ID of the section.
```

--------------------------------

### GET /get_project/{project_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific project.

```APIDOC
## GET /get_project/{project_id}

### Description
Retrieves details for a specific project.

### Method
GET

### Endpoint
/get_project/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
```

--------------------------------

### Initialize Coding Agent

Source: https://docs.guild.ai/quickstart

A prompt template for automated coding assistants to set up the Guild environment.

```text
Install the Guild CLI globally with npm: npm install -g @guildai/cli
Authenticate by running: guild auth login --no-browser
This will print a URL. Tell me to open it in my browser to complete authentication, then wait for the command to finish.
After auth succeeds, run: guild setup
This will install skills for guild agent development.
Then select the home workspace: guild workspace select home
Then create a new agent: mkdir hello-agent && cd hello-agent && guild agent init --name hello-agent --template LLM
Edit agent.ts to be a friendly greeting agent using llmAgent with multi-turn mode and guildTools.
Test the agent with: echo '{"prompt":"Hello!"}' | guild agent test --mode json
Ask me if the response looks good. Once I confirm, save and publish with: guild agent save --message "First version" --wait --publish
```

--------------------------------

### GET /get_projects

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of all projects in the TestRail instance.

```APIDOC
## GET /get_projects

### Description
Retrieves a list of all projects in the TestRail instance.

### Method
GET

### Endpoint
/get_projects
```

--------------------------------

### Manage integration versions

Source: https://docs.guild.ai/cli/commands

Commands for listing, creating, building, and publishing specific versions of an integration.

```bash
guild integration version list <id_or_name>                 # List versions
guild integration version create <id_or_name>               # Create a draft version
guild integration version get <id_or_name>                  # Get latest version details
guild integration version get <id_or_name> --version-number 1.0.0

guild integration version build <id_or_name> --version-number 1.0.0   # Validate a draft
guild integration version publish <id_or_name> --version-number 1.0.0 # Publish a built version
```

--------------------------------

### GET /repos/{owner}/{repo}/issues

Source: https://docs.guild.ai/integrations/github

List issues for a repository.

```APIDOC
## GET /repos/{owner}/{repo}/issues

### Description
List issues for a repository.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/issues

### Parameters
#### Path Parameters
- **owner** (string) - Required
- **repo** (string) - Required
```

--------------------------------

### Initialize Google Drive tools in an agent

Source: https://docs.guild.ai/integrations/google-drive

Integrate all available Google Drive tools into an LLM agent using the SDK.

```typescript
import { googleDriveTools } from "@guildai-services/guildai~google-drive"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages files in Google Drive",
  tools: { ...googleDriveTools },
})
```

--------------------------------

### GET /get_run/{run_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific test run.

```APIDOC
## GET /get_run/{run_id}

### Description
Retrieves details for a specific test run.

### Method
GET

### Endpoint
/get_run/{run_id}

### Parameters
#### Path Parameters
- **run_id** (string) - Required - The ID of the run.
```

--------------------------------

### GET /get_case/{case_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific test case.

```APIDOC
## GET /get_case/{case_id}

### Description
Retrieves details for a specific test case.

### Method
GET

### Endpoint
/get_case/{case_id}

### Parameters
#### Path Parameters
- **case_id** (string) - Required - The ID of the case.
```

--------------------------------

### Manage skill packages

Source: https://docs.guild.ai/cli/commands

Commands for creating, searching, updating, and archiving skill packages.

```bash
guild skill create <name>                    # Create a new skill
guild skill create <name> --overview "..."   # Create with description
guild skill get <identifier>                 # Get skill details (name or UUID)
guild skill list                             # List skills
guild skill list --search "tone"             # Search skills
guild skill search "compliance"              # Search skills by keyword
guild skill search "tone" --published        # Only show published skills
guild skill update <identifier> --overview "New description"
guild skill update <identifier> --public     # Make public (requires admin)
guild skill archive <identifier>             # Archive the skill
guild skill unarchive <identifier>           # Restore an archived skill
```

--------------------------------

### GET /get_sections/{project_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of sections for a specific project.

```APIDOC
## GET /get_sections/{project_id}

### Description
Retrieves a list of sections for a specific project.

### Method
GET

### Endpoint
/get_sections/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
```

--------------------------------

### Create and update integrations

Source: https://docs.guild.ai/cli/commands

Commands for defining new integrations with API key or OAuth authentication and updating existing configurations.

```bash
# Create a new integration with API key auth
guild integration create my-service \
  --base-url https://api.example.com \
  --auth-scheme api-key \
  --description "Connect to the Acme API"

# Create with OAuth
guild integration create my-oauth-service \
  --base-url https://api.example.com \
  --auth-scheme oauth \
  --install-url https://example.com/oauth/authorize \
  --token-url https://example.com/oauth/token \
  --client-id <id> --client-secret <secret> \
  --scopes "read,write"

# Update an existing integration
guild integration update myorg~my-service --description "Updated description"
guild integration update myorg~my-service --base-url https://api.v2.example.com
```

--------------------------------

### Manage skill versions

Source: https://docs.guild.ai/cli/commands

Commands for creating, listing, and retrieving specific versions of a skill.

```bash
guild skill version create <identifier> \
  --version-number 1.0.0 \
  --description "Runtime description" \
  --body-file content.md                     # Create a version from file

guild skill version list <identifier>        # List versions
guild skill version get <version-id>         # Get version details
```

--------------------------------

### GET /get_suite/{suite_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves details for a specific test suite.

```APIDOC
## GET /get_suite/{suite_id}

### Description
Retrieves details for a specific test suite.

### Method
GET

### Endpoint
/get_suite/{suite_id}

### Parameters
#### Path Parameters
- **suite_id** (string) - Required - The ID of the suite.
```

--------------------------------

### Agent Likes API

Source: https://docs.guild.ai/sdk/task-object

Methods for managing agent likes and workspace installations.

```APIDOC
## Agent likes

- create_agent_like: Like an agent on behalf of the current user
- delete_agent_like: Unlike an agent
- list_agent_likers: List the users who have liked a given agent
- list_agent_workspaces: List the workspaces that have installed a given agent
```

--------------------------------

### Create a session via CLI

Source: https://docs.guild.ai/platform/sessions

Use this command to initialize a new conversation with a specific agent within a designated workspace.

```bash
guild session create --agent <agent-name> --workspace <workspace-id>
```

--------------------------------

### GET /get_tests/{run_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of tests for a specific test run.

```APIDOC
## GET /get_tests/{run_id}

### Description
Retrieves a list of tests for a specific test run.

### Method
GET

### Endpoint
/get_tests/{run_id}

### Parameters
#### Path Parameters
- **run_id** (string) - Required - The ID of the run.
```

--------------------------------

### Connect integration credentials

Source: https://docs.guild.ai/cli/commands

Commands for establishing authentication credentials for an integration.

```bash
guild integration connect myorg~my-service                  # Interactive prompt
guild integration connect myorg~my-service --token <value>  # Non-interactive
```

--------------------------------

### Initialize Bitbucket tools in an agent

Source: https://docs.guild.ai/integrations/bitbucket

Import and register all available Bitbucket tools within an LLM agent definition.

```typescript
import { bitbucketTools } from "@guildai-services/guildai~bitbucket"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that manages Bitbucket pull requests",
  tools: { ...bitbucketTools },
})
```

--------------------------------

### GET /get_runs/{project_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of test runs for a specific project.

```APIDOC
## GET /get_runs/{project_id}

### Description
Retrieves a list of test runs for a specific project.

### Method
GET

### Endpoint
/get_runs/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
```

--------------------------------

### GET /get_attachments_for_case/{case_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves attachments associated with a specific test case.

```APIDOC
## GET /get_attachments_for_case/{case_id}

### Description
Retrieves attachments associated with a specific test case.

### Method
GET

### Endpoint
/get_attachments_for_case/{case_id}

### Parameters
#### Path Parameters
- **case_id** (string) - Required - The ID of the case.
```

--------------------------------

### Initializing platform tools

Source: https://docs.guild.ai/sdk/tools

Include the standard platform tools to enable access to Guild API operations and workspace context.

```typescript
import { guildTools } from "@guildai/agents-sdk";

const tools = { ...guildTools };
```

--------------------------------

### GET /get_cases/{project_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of test cases for a specific project.

```APIDOC
## GET /get_cases/{project_id}

### Description
Retrieves a list of test cases for a specific project.

### Method
GET

### Endpoint
/get_cases/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
```

--------------------------------

### Select Workspace

Source: https://docs.guild.ai/cli/introduction

Prompts to select a default workspace and saves the configuration to ~/.guild/config.json.

```bash
guild workspace select
```

--------------------------------

### Publishing and Version Management

Source: https://docs.guild.ai/cli/commands

Commands for publishing agent versions, waiting for validation, and listing versions.

```bash
guild agent publish              # Publish the latest draft version
guild agent publish --wait       # Wait for validation before publishing
guild agent publish --wait --timeout 300  # Specify validation/publish wait timeout (default: 300s)
guild agent unpublish            # Unpublish the latest published version
guild agent versions             # List all versions
```

--------------------------------

### GET /get_suites/{project_id}

Source: https://docs.guild.ai/integrations/testrail

Retrieves a list of test suites for a specific project.

```APIDOC
## GET /get_suites/{project_id}

### Description
Retrieves a list of test suites for a specific project.

### Method
GET

### Endpoint
/get_suites/{project_id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.
```

--------------------------------

### GET /repositories/{workspace}/{repo_slug}/issues

Source: https://docs.guild.ai/integrations/bitbucket

Retrieves a list of issues for a repository.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}/issues

### Description
Retrieves a list of issues for a repository.

### Method
GET

### Endpoint
/repositories/{workspace}/{repo_slug}/issues

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or slug.
- **repo_slug** (string) - Required - The repository slug.
```

--------------------------------

### Initialize Google Slides tools in an agent

Source: https://docs.guild.ai/integrations/google-slides

Integrate the full suite of Google Slides tools into an LLM agent.

```typescript
import { googleSlidesTools } from "@guildai-services/guildai~google-slides"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that reads and edits Google Slides presentations",
  tools: { ...googleSlidesTools },
})
```

--------------------------------

### Session Error Message

Source: https://docs.guild.ai/cli/commands

Example of the error message displayed when a session cannot be resumed.

```text
Cannot resume session '<id>': it does not exist or you do not have access to it. List your sessions with: guild session list
```

--------------------------------

### Typical agent task usage

Source: https://docs.guild.ai/sdk/task-object

Demonstrates an agent utilizing task.console, task.ui, and task.guild services.

```typescript
import {
  agent,
  guildTools,
  progressLogNotifyEvent,
  userInterfaceTools,
  type Task,
} from "@guildai/agents-sdk"
import { z } from "zod"

const inputSchema = z.object({ workspace_id: z.string() })
const outputSchema = z.object({
  workspace_name: z.string(),
  context_count: z.number(),
})

const tools = { ...guildTools, ...userInterfaceTools }
type Tools = typeof tools

async function run(
  input: z.infer<typeof inputSchema>,
  task: Task<Tools>,
): Promise<z.infer<typeof outputSchema>> {
  "use agent"
  task.console.info({ sessionId: task.sessionId }, "starting run")

  await task.ui.notify(progressLogNotifyEvent("Fetching workspace..."))
  const workspace = await task.guild!.get_workspace({
    workspace_id: input.workspace_id,
  })

  await task.ui.notify(progressLogNotifyEvent("Checking context history..."))
  const { items } = await task.guild!.get_workspace_contexts({
    workspace_id: input.workspace_id,
    limit: 100,
  })

  return { workspace_name: workspace.name, context_count: items.length }
}

export default agent({
  description: "Typical task usage.",
  inputSchema,
  outputSchema,
  tools,
  run,
})
```

--------------------------------

### Agent Discovery and Management

Source: https://docs.guild.ai/cli/commands

Commands for listing, searching, creating, updating, and cloning agents.

```bash
guild agent list                             # List your agents
guild agent search "code review"             # Search published agents
guild agent get <agent-id>                   # Get agent details
guild agent create <name>                    # Create an agent record
guild agent update <agent-id> --description "New description"
guild agent clone <agent-id>                 # Clone an agent's code locally
guild agent code <agent-id>                  # Fetch published code
guild agent code <agent-id> --draft          # Include draft versions
```

--------------------------------

### Manage workspace agents

Source: https://docs.guild.ai/cli/commands

Commands to list, install, or remove agents within a workspace.

```bash
guild workspace agent list                    # List agents installed in workspace
guild workspace agent add <identifier>        # Install an agent
guild workspace agent remove <identifier>     # Remove an agent
```

--------------------------------

### GET /api/sessions/{session_id}

Source: https://docs.guild.ai/platform/triggers

Retrieves the current execution state and metadata of a specific session.

```APIDOC
## GET /api/sessions/{session_id}

### Description
Retrieves the current execution state and metadata of a specific session.

### Method
GET

### Endpoint
/api/sessions/{session_id}

### Parameters
#### Path Parameters
- **session_id** (string) - Required - The ID of the session.
```

--------------------------------

### Initialize an agent with SendGrid tools

Source: https://docs.guild.ai/integrations/sendgrid

Integrate the full suite of SendGrid tools into an LLM agent using the SDK.

```typescript
import { sendgridTools } from "@guildai-services/guildai~sendgrid"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that sends transactional email",
  tools: { ...sendgridTools },
})
```

--------------------------------

### Create or Update Integration via CLI

Source: https://docs.guild.ai/services/create-an-integration

Use these commands to define or modify integrations, including webhook event configurations.

```bash
guild integration create my-service \
  --base-url https://api.example.com \
  --auth-scheme api-key \
  --webhook-events '[{"event": "push"}, {"event": "pull_request", "actions": ["opened", "closed"]}]'
```

```bash
guild integration update myorg~my-service \
  --webhook-events '[{"event": "deploy", "actions": ["started", "completed", "failed"]}]'
```

--------------------------------

### GET /repositories/{workspace}/{repo_slug}/diff/{spec}

Source: https://docs.guild.ai/integrations/bitbucket

Retrieves the diff for a specific specification.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}/diff/{spec}

### Description
Retrieves the diff for a specific specification.

### Method
GET

### Endpoint
/repositories/{workspace}/{repo_slug}/diff/{spec}

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or slug.
- **repo_slug** (string) - Required - The repository slug.
- **spec** (string) - Required - The diff specification.
```

--------------------------------

### GET /repositories/{workspace}/{repo_slug}/src

Source: https://docs.guild.ai/integrations/bitbucket

Retrieves the source code root for a repository.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}/src

### Description
Retrieves the source code root for a repository.

### Method
GET

### Endpoint
/repositories/{workspace}/{repo_slug}/src

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or slug.
- **repo_slug** (string) - Required - The repository slug.
```

--------------------------------

### Initialize Google Logging Tools

Source: https://docs.guild.ai/integrations/google-logging

Integrate all available Google Logging tools into a Guild AI agent.

```typescript
import { googleLoggingTools } from "@guildai-services/guildai~google-logging"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  description: "An agent that searches and analyzes Google Cloud logs",
  tools: { ...googleLoggingTools },
})
```

--------------------------------

### GET /repositories/{workspace}/{repo_slug}/issues/{issue_id}

Source: https://docs.guild.ai/integrations/bitbucket

Retrieves details for a specific issue.

```APIDOC
## GET /repositories/{workspace}/{repo_slug}/issues/{issue_id}

### Description
Retrieves details for a specific issue.

### Method
GET

### Endpoint
/repositories/{workspace}/{repo_slug}/issues/{issue_id}

### Parameters
#### Path Parameters
- **workspace** (string) - Required - The workspace ID or slug.
- **repo_slug** (string) - Required - The repository slug.
- **issue_id** (integer) - Required - The ID of the issue.
```

--------------------------------

### POST /{service}

Source: https://docs.guild.ai/integrations/pipedream

Execute a natural language instruction using Pipedream MCP tools for the specified service.

```APIDOC
## POST /{service}

### Description
Execute a natural language instruction using Pipedream MCP tools for the specified service.

### Method
POST

### Endpoint
/{service}

### Parameters
#### Path Parameters
- **service** (string) - Required - The integration service to use (e.g., 'notion', 'google_docs').
```
Tokens:
Raw