Skip to main content

Introduction

This guide provides step-by-step instructions for integrating and using the Azure DevOps Boards (ADO Boards) toolkit within ELITEA. It covers everything from setting up your Azure DevOps Personal Access Token to configuring the toolkit and using it within your Agents, Pipelines, and Chat conversations. Azure Boards (ADO Boards) Azure Boards is a work tracking and project management service for planning, organizing, and tracking tasks, user stories, bugs, features, and epics. It includes agile planning tools, customizable dashboards, and workflow automation to help teams manage their work effectively. Integrating Azure DevOps Boards with ELITEA enables your Agents, Pipelines, and Chat conversations to intelligently interact with work items — automating bug creation, status updates, task searches, and linking as part of AI-driven workflows.

Toolkit’s Account Setup and Configuration

Account Setup

Create an Azure DevOps account and organization to access the Boards service.
  1. Visit Azure DevOps: Navigate to https://dev.azure.com/
  2. Start Free or Sign In: Click “Start free” to create a new organization, or “Sign in to Azure DevOps” for existing accounts
  3. Create Organization: Follow prompts to set up your organization (provide name, select hosting region, optionally link to Azure account)
  4. Verify Email: Confirm your email address if prompted
  5. Enable Basic Subscription: Verify Basic subscription is enabled (typically enabled by default)
  6. Add Users (Optional): Navigate to https://dev.azure.com/{YourOrganizationName}/_settings/users, click “Add users”, enter user details, select “Basic” access level, and click “Add” Add user
  7. Verify Access: Confirm “Boards” appears in the left sidebar of your project
If Boards isn’t visible, verify it is enabled in organization settings under General → Services.

Generate a Personal Access Token (PAT)

For secure integration with ELITEA, use an Azure DevOps Personal Access Token (PAT).
  1. Log in to Azure DevOps: Navigate to https://dev.azure.com/ and log in.
  2. Access User Settings: Click the User settings icon (top right) → select “Personal access tokens”.
  3. Generate New Token: Click ”+ New Token”.
  4. Configure Token Details:
    • Name: Enter a descriptive label (e.g., “ELITEA Boards Integration”)
    • Organization: Select your organization
    • Expiration: Set an expiration date
    • Scopes: Select Custom defined, then enable:
      • Work itemsRead (to read work item details)
      • Work itemsWrite (to create or update work items — only if needed)
  5. Create Token: Click “Create”.
  6. Copy and Store Token: Copy the token immediately and store it securely in a password manager or ELITEA’s Secrets feature. Generate PAT
Principle of Least Privilege: Grant only the scopes essential for your ELITEA integration.Avoid “Full Access” Scopes: Never grant full access unless absolutely necessary.Regular Token Review and Rotation: Rotate tokens periodically as a security best practice.

System Integration with ELITEA

To integrate Azure DevOps Boards with ELITEA, follow this three-step process: Create Credentials → Create Toolkit → Use in Agents.

Step 1: Create Azure DevOps Credentials

  1. Navigate to Credentials Menu: Open the sidebar and select Credentials.
  2. Create New Credential: Click the + Create button.
  3. Select Azure DevOps: Choose Ado as the credential type. Azure DevOps Credential Access
  4. Configure Credential Details:
    FieldDescriptionExample
    Display NameDescriptive name for the credentialAzure DevOps - Boards Access
    IDUnique identifierAuto-populated from the Display Name
    Organization UrlYour Azure DevOps organization URLhttps://dev.azure.com/MyCompany
    TokenYour PAT or a secret containing your PATghp_1234...
  5. Test Connection: Click Test Connection to verify credentials.
  6. Save Credential: Click Save. Create Credentials
Use Secrets for your PAT instead of entering values directly.

Step 2: Create the Azure DevOps Boards Toolkit

  1. Navigate to Toolkits Menu: Open the sidebar and select Toolkits.
  2. Create New Toolkit: Click the + Create button.
  3. Select Azure Boards: Choose Azure Boards (ADO Board) from the available toolkit types. Azure Boards Toolkit Access
  4. Configure Toolkit Settings:
    FieldDescriptionExample
    Toolkit NameDescriptive name for your toolkitADO Boards - Work Item Manager
    DescriptionOptional description of the toolkit’s purposeToolkit for managing work items, bugs, and user stories
    Ado ConfigurationSelect your Azure DevOps credential. A credential may be pre-selected — verify it is correct or change it as needed.Azure DevOps - Boards Access
    PgVector ConfigurationPgVector connection for vector database (required for indexing tools)elitea-pgvector
    Embedding ModelEmbedding model for semantic searchtext-embedding-3-small
    ProjectYour Azure DevOps project nameProjectAlpha
    LimitDefault result limit for board queries (can be overridden by agent instructions)5
  5. Enable Desired Tools: Select the checkboxes next to the specific boards tools you want to enable. Enable only the tools your agents will actually use.
  6. Save Toolkit: Click Save. Create Boards Toolkit

Available Boards Tools

Tool CategoryTool NameDescriptionPrimary Use Case
Work Item Search & Retrieval
Search work itemsSearch for work items using a WIQL query and dynamically fetch fieldsFind tasks, bugs, or user stories matching criteria
Get work itemGet a single work item by IDRetrieve detailed information about a specific work item
Get commentsGet comments for a work item by IDAccess discussion and collaboration history
Get work item type fieldsGet fields for a specific work item typeRetrieve field definitions and metadata
Work Item Management
Create work itemCreates new work itemsAdd new tasks, bugs, or features programmatically
Update work itemUpdates existing work itemsModify work item status, fields, or properties
Delete work itemDeletes a work item by IDRemove obsolete or incorrect work items
Work Item Linking
Link work itemsAdd a relation to the source work itemEstablish relationships between work items
Get relation typesReturns available relation typesDiscover valid link types for work items
Link work items to wiki pageLinks work items to a specific wiki page using ArtifactLinkConnect work items with wiki documentation
Unlink work items from wiki pageRemoves ArtifactLink between work items and a wiki pageRemove work item associations from wiki pages
Indexing & Search
Index dataLoads Azure DevOps work item data to index for semantic searchEnable AI-powered semantic search across work items
Search indexPerforms searches across indexed contentFind specific work item content across indexed data
Stepback search indexPerforms advanced contextual searches with broader scopeExecute sophisticated searches with expanded context
Stepback summary indexCreates comprehensive summaries of indexed contentGenerate intelligent summaries of work item information
Remove indexRemoves previously created search indexesClean up and manage indexed content
List collectionsLists available indexed collectionsView and manage indexed data collections
The tools Index data, List collections, Remove index, Search index, Stepback search index, and Stepback summary index require PgVector configuration and an embedding model.
When retrieving work items with attachments, the toolkit can parse and extract content from the following file types:
  • Documents: Word (.docx), PowerPoint (.pptx), CSV
  • Email files: Outlook Message (.msg), MIME Email (.eml) — including email metadata (sender, recipients, subject, date, CC/BCC), body content (plain text and HTML), and nested attachments

Testing Toolkit Tools

After configuring the toolkit, test individual tools from the Toolkit detail page using the Test Settings panel:
  1. Select LLM Model from the model dropdown
  2. Select a Tool from the available boards tools
  3. Provide Input — enter required parameters or test queries
  4. Run the Test and review the response
  • Verify that credentials and connection are configured correctly
  • Validate tool functionality with your Azure DevOps environment
  • Test different parameter combinations before production use
For detailed instructions, see How to Test Toolkit Tools.

Step 3: Add the Boards Toolkit to Your Workflows

In Agents

  1. Navigate to Agents: Open the sidebar and select Agents.
  2. Create or Edit Agent: Create a new agent or select an existing one.
  3. Add the Toolkit: In the TOOLKITS section, click “+Toolkit” and select your ADO Boards toolkit.
Add to Agent

In Pipelines

  1. Navigate to Pipelines: Open the sidebar and select Pipelines.
  2. Create or Edit Pipeline: Create a new pipeline or select an existing one.
  3. Add the Toolkit: In the TOOLKITS section, click “+Toolkit” and select your ADO Boards toolkit.
Add to Pipeline

In Chat

  1. Navigate to Chat: Open the sidebar and select Chat.
  2. Start New Conversation: Click +Create or open an existing conversation.
  3. Add the Toolkit: In the Participants section, click to add a toolkit and select your ADO Boards toolkit.
Add to Chat
  • “Find all high-priority bugs assigned to me.”
  • “Create a new bug for the login issue I just found.”
  • “List all open tasks assigned to the current sprint.”

Instructions and Prompts for Using the ADO Boards Toolkit

When crafting instructions for agents using the ADO Boards toolkit, clarity and precision are essential. Break down tasks into simple, actionable steps and explicitly define all parameters. Effective instructions are:
  • Direct and Action-Oriented: Use strong action verbs (e.g., “Use the ‘search_work_items’ tool…”, “Create a work item using ‘create_work_item’…”)
  • Parameter-Centric: Specify each required parameter and how the agent should obtain its value
  • Step-by-Step Structured: Use numbered steps for complex workflows
Searching for Work Items:
1. Goal: Find all high-priority tasks assigned to the current user.
2. Tool: Use the "search_work_items" tool.
3. Parameters:
    - query: "WIQL query to find Active Tasks with Priority 1 assigned to @Me"
4. Outcome: Display the list of matching work items with ID, title, state, and priority.
Creating a Work Item:
1. Goal: Create a new work item in Azure Boards based on user requirements.
2. Tool: Use the "create_work_item" tool.
3. Parameters:
    - work_item_type: "Ask the user for the type (Task, Bug, User Story, etc.)"
    - title: "Get the work item title from the user"
    - description: "Ask the user for work item details"
    - assigned_to: "Optional — ask if the work item should be assigned to someone"
4. Outcome: Confirm creation to the user with the new work item ID.

Chat Usage Examples

Chat Example:
User: "Find all high-priority bugs assigned to me."

Agent Response: [Agent uses search_work_items tool]

🔍 **Search Results: High-Priority Bugs** (3 items):

1. **Bug #1234**: Application crashes on file upload
   - **Priority**: High (Priority 1) | **State**: Active | **Created**: Nov 8, 2025

2. **Bug #1245**: Memory leak in background service
   - **Priority**: High (Priority 1) | **State**: Active | **Created**: Nov 10, 2025

3. **Bug #1251**: Data validation error in user registration
   - **Priority**: High (Priority 1) | **State**: Active | **Created**: Nov 11, 2025
Chat Example:
User: "Create a new task to update the API documentation."

Agent Response: [Agent uses create_work_item tool]

✅ **Work Item Created Successfully!**

- **Work Item ID**: #1256
- **Type**: Task
- **Title**: Update API documentation
- **State**: New | **Priority**: Medium
Chat Example:
User: "Change the status of work item #1234 to 'In Progress'."

Agent Response: [Agent uses update_work_item tool]

✅ **Work Item Updated Successfully!**

- **Work Item ID**: #1234
- **Updated Field**: State → **In Progress**

Best Practices

After setting up the toolkit, test each tool you intend to use to ensure connectivity, correct authentication, and accurate execution of board actions.
Regularly monitor agents using the ADO Boards toolkit. Track task completion, execution time, and error rates.
  • Use Personal Access Tokens instead of your main account password
  • Grant only the minimum necessary scopes (Work items: Read, Write only if needed)
  • Store PATs using ELITEA’s Secrets Management feature
Craft clear, unambiguous agent instructions. Use WIQL queries precisely and specify field names as required by the Azure DevOps API.
Begin with read-only operations (searching and retrieving work items) before enabling write operations (creating or updating items).
  • Scenario: Developers use ELITEA Agents to quickly find work items assigned to them, filtered by priority or status.
  • Tools Used: search_work_items
  • Example Instruction: “Use ‘search_work_items’ to find all ‘Task’ work items assigned to me that are currently ‘Active’, sorted by Priority.”
  • Benefit: Improves daily task prioritization without leaving ELITEA.
  • Scenario: When automated tests detect a bug, automatically create a Bug work item pre-populated with error details.
  • Tools Used: create_work_item
  • Example Instruction: “Use ‘create_work_item’ to create a new ‘Bug’ with title ‘Automated Test Failure Detected’ and description containing the error logs from the failed workflow step.”
  • Benefit: Ensures timely, consistent bug reporting directly from ELITEA workflows.
  • Scenario: As tasks progress through ELITEA workflows, automatically update the status of linked work items.
  • Tools Used: update_work_item
  • Example Instruction: “Use ‘update_work_item’ to set the State of work item [ID] to ‘In Progress’ when the workflow reaches the Development stage.”
  • Benefit: Keeps work item statuses synchronized with actual project progress automatically.

Troubleshooting

Problem: Agent fails to connect to Azure DevOps Boards.
  1. Verify the organization URL is correct (e.g., https://dev.azure.com/YourOrganizationName)
  2. Check that your PAT is accurate and not expired
  3. Regenerate the PAT if needed and update your ELITEA credential
  4. Verify network connectivity and firewall settings
Problem: “Permission Denied” or “Unauthorized” errors.
  1. Ensure the PAT has the vso.work_full scope (or at minimum vso.work for read-only)
  2. Verify your Azure DevOps account has the necessary project permissions
  3. Check that the PAT has not expired
Problem: Cannot find specified organization or project.
  1. Verify the organization name matches your Azure DevOps URL exactly
  2. Confirm the project name is correct (case-sensitive)
  3. Ensure the URL format is: https://dev.azure.com/YourOrganizationName
Problem: Cannot access specific work items.
  1. Confirm the work item ID exists in the specified project
  2. Verify the PAT has appropriate work item scopes
  3. Ensure Boards is enabled for the project (Project Settings → Services)
  4. Check your account has permission to access the specific area path
Problem: Indexing tools fail or search returns no results.
  1. Verify PgVector is properly configured in toolkit settings
  2. Confirm an embedding model is selected
  3. Ensure the index was created successfully before searching
  4. Verify there is data available to index
Problem: The create_work_item or update_work_item tool returns an error about invalid or unrecognized field names.Cause: Work item fields must be specified using their Azure DevOps reference names (e.g. System.Title), not display names.
  1. Use the Get work item type fields tool to retrieve the correct reference names for your work item type (e.g. Task, Bug, Epic)
  2. If the field list looks outdated after a project configuration change, instruct the agent to use force_refresh=True when calling the tool to reload definitions from Azure DevOps
  3. Use the following common reference names as a starting point:
    Display NameReference Name
    TitleSystem.Title
    StateSystem.State
    Assigned ToSystem.AssignedTo
    Area PathSystem.AreaPath
    Iteration PathSystem.IterationPath
    PriorityMicrosoft.VSTS.Common.Priority
    TagsSystem.Tags
  4. Ensure the JSON payload uses the correct structure:
    {"fields": {"System.Title": "My Task", "System.AreaPath": "ProjectAlpha"}}
    

Support Contact

If you encounter issues not covered in this guide, contact the ELITEA support team.Email: SupportAlita@epam.com

FAQ

No. You must use a Personal Access Token for secure integration. Regular passwords are not supported.
Grant Work items → Read for read-only access, and additionally Work items → Write if the agent needs to create or update work items. Always follow the principle of least privilege.
https://dev.azure.com/YourOrganizationName — replace YourOrganizationName with your actual organization name. Do not include the project name in the URL.
Yes. One Azure DevOps credential can be reused across Wiki, Boards, and Test Plans toolkits as long as the PAT has the necessary scopes for all services.
Your organization name appears in the URL when you log in (e.g., https://dev.azure.com/YourOrgName). Project names are listed in the Azure DevOps interface under your organization.
Verify the PAT has the vso.work_write scope for write operations. Also ensure your Azure DevOps account has project-level permissions — a valid token does not automatically grant project access.
No. PgVector is only required for indexing and semantic search tools: Index data, Search index, Stepback search index, Stepback summary index, Remove index, and List collections. All other boards tools work without it.
Yes. For example, you can add both the Boards toolkit and the Wiki toolkit to an agent that needs to update documentation and create work items.
  1. Generate a new PAT in Azure DevOps
  2. Navigate to Credentials in ELITEA
  3. Edit your Azure DevOps credential and update the Token field
  4. Save the credential — all toolkits using it will automatically use the new token
Both create_work_item and update_work_item expect a JSON string with a fields key containing Azure DevOps field reference names:
{
  "fields": {
    "System.Title": "Fix login timeout bug",
    "System.Description": "Users are logged out after 5 minutes of inactivity.",
    "System.AreaPath": "ProjectAlpha",
    "System.IterationPath": "ProjectAlpha\\Sprint 12",
    "Microsoft.VSTS.Common.Priority": 1,
    "System.AssignedTo": "user@example.com"
  }
}
Use the Get work item type fields tool to discover all available reference names for a specific work item type (e.g. Task, Bug, Epic).
Yes. By default, search_work_items returns up to the Limit value configured in the toolkit settings (default: 5). To retrieve all matching results, set limit=-1 in the agent instruction:
Use the 'search_work_items' tool with limit=-1 to return all matching work items.
Use this with care on large projects, as it may return a very large number of items.