Skip to main content

ALM Traceability MCP Tools - Azure DevOps, Jira, and Vector Search integration

Project description

ALM Traceability MCP Server

PostgreSQL-based Model Context Protocol (MCP) server for ALM traceability management across Azure DevOps, Jira, and vector search.

Features

  • Azure DevOps Integration - User stories, test cases, work items
  • Jira Integration - Issues, test cases, custom fields
  • PostgreSQL Traceability - Persistent traceability matrix
  • Vector Search - Similarity search with Google Cloud Vertex AI
  • Batch Operations - Create multiple test cases efficiently
  • MCP Protocol - Full Claude Desktop integration

Installation

Option 1: Direct Python Installation

# Clone repository
git clone https://github.com/Vk171127/mcp-server-for-alm-tools.git
cd mcp-server-for-alm-tools

# Install
pip install -e .

# With vector search support
pip install -e ".[vector]"

Option 2: Using NPX (Recommended for MCP)

# Install globally
npm install -g @yourorg/alm-traceability-mcp

# Or use directly with npx
npx @yourorg/alm-traceability-mcp

Configuration

1. Environment Variables

Copy .env.example to .env and configure:

# Azure DevOps
ADO_ORG=your-organization
ADO_PROJECT=your-project
ADO_PAT=your-pat-token

# Jira
JIRA_BASE_URL=https://yourcompany.atlassian.net
JIRA_EMAIL=your-email@company.com
JIRA_API_TOKEN=your-api-token
JIRA_PROJECT_KEY=PROJECT

# PostgreSQL
DB_HOST=localhost
DB_PORT=5432
DB_NAME=alm_traceability
DB_USER=postgres
DB_PASSWORD=your-password

2. Claude Desktop Configuration

Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "alm-traceability": {
      "command": "python",
      "args": ["-m", "mcp_main"],
      "env": {
        "ADO_ORG": "your-org",
        "ADO_PROJECT": "your-project",
        "ADO_PAT": "your-pat",
        "DB_HOST": "localhost",
        "DB_NAME": "alm_traceability",
        "DB_USER": "postgres",
        "DB_PASSWORD": "your-password"
      }
    }
  }
}

3. Database Setup

-- Create database
CREATE DATABASE alm_traceability;

-- Run schema (see schema.sql)
\i schema.sql

Usage

Starting the Server

# Activate virtual environment
source venv/bin/activate

# Run server
python -m mcp_main

Available MCP Tools

Configuration Tools

  • configure_ado_connection - Set up Azure DevOps
  • configure_jira_connection - Set up Jira
  • initialize_traceability_database - Initialize PostgreSQL

Azure DevOps Tools

  • fetch_user_story - Get user story details
  • fetch_testcases - Get linked test cases
  • create_testcase - Create new test case
  • batch_create_testcases - Create multiple test cases
  • prepare_test_case_context - Prepare context for generation

Jira Tools

  • fetch_jira_issue - Get Jira issue details
  • fetch_jira_testcases - Get linked test cases
  • create_jira_testcase - Create new test case
  • batch_create_jira_testcases - Create multiple test cases
  • prepare_jira_test_case_context - Prepare context for generation

Traceability Tools

  • create_traceability_link - Link items
  • get_traceability_links_for_item - Get all links
  • generate_traceability_report - Generate reports
  • get_traceability_matrix_for_session - Get full matrix

Vector Search Tools

  • search_similar_stories - Find similar user stories
  • configure_vertex_ai - Set up vector search

Example Usage with Claude

User: "Configure Azure DevOps for my organization 'contoso' and project 'HealthApp'"

Claude: [calls configure_ado_connection]

User: "Fetch user story 12345 and prepare context for test generation"

Claude: [calls prepare_test_case_context with user_story_id=12345]

User: "Generate 5 test cases covering positive, negative, and edge cases"

Claude: [calls batch_create_testcases with generated test cases]

Development

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black .
isort .

# Lint
flake8

Architecture

┌─────────────────┐
│  Claude Desktop │
└────────┬────────┘
         │ MCP Protocol
         ▼
┌─────────────────┐
│   MCP Server    │
│   (Python)      │
└────────┬────────┘
         │
    ┌────┴────┬────────┬─────────┐
    ▼         ▼        ▼         ▼
┌───────┐ ┌──────┐ ┌──────┐ ┌──────────┐
│  ADO  │ │ Jira │ │ DB   │ │ Vector   │
│Client │ │Client│ │(PG)  │ │ Search   │
└───────┘ └──────┘ └──────┘ └──────────┘

Troubleshooting

Common Issues

  1. Connection Refused

    • Ensure PostgreSQL is running
    • Check connection string in .env
  2. Authentication Errors

    • Verify PAT/API tokens are valid
    • Check token permissions
  3. Import Errors

    • Ensure all dependencies installed: pip install -e ".[vector]"
    • Activate virtual environment

Logs

Check logs at: ~/.mcp/logs/alm-traceability.log

License

MIT

Contributing

  1. Fork the repository
  2. Create feature branch
  3. Make changes
  4. Run tests
  5. Submit pull request

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alm_traceability_mcp-1.0.2.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alm_traceability_mcp-1.0.2-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file alm_traceability_mcp-1.0.2.tar.gz.

File metadata

  • Download URL: alm_traceability_mcp-1.0.2.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for alm_traceability_mcp-1.0.2.tar.gz
Algorithm Hash digest
SHA256 828f6c186042659f253fff45b6afdd4f6f337c508ab245b2795f45dddf78a6de
MD5 770707a31f98a4f0a70a889a406c608a
BLAKE2b-256 c23e57843c037b82e67dbe4b0f9e33b07bed59bedde0df30158c81863bffc042

See more details on using hashes here.

File details

Details for the file alm_traceability_mcp-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for alm_traceability_mcp-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 97ecc771a415b4df25988d17ac84f7353c3b41e9c9fee91a859537e95754289e
MD5 09f0234b92e3da02c6e88d5901a23ec0
BLAKE2b-256 f8ac5c96b7122c023e3e4d6a027d57354abde38debf667473f43d6e55b424e74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page