Skip to main content

An MCP server for Freshrelease - enables Cursor AI to interact with Freshrelease projects

Project description

Freshrelease MCP Server

PyPI version Python 3.10+

An MCP server that enables AI models to interact with Freshrelease through powerful tools for complete project and test management.

🚀 Key Features

  • 🤖 AI-Native: Built specifically for AI model integration via MCP protocol
  • 🔧 Complete Management: Projects, tasks, test cases, test runs, and user management
  • 🧠 Smart Resolution: Automatically converts names to IDs (users, sprints, projects, etc.)
  • 📋 Native Filtering: Full support for Freshrelease's native query_hash format
  • 🌲 Hierarchical Navigation: Navigate through 7-level deep section hierarchies
  • ⚡ Performance Optimized: Built-in caching, connection pooling, and batch processing
  • 🎯 Label-Based Filtering: Use intuitive field names like "Owner" instead of "owner_id"

📊 Tools Overview

Category Key Features
Core Management Projects, tasks, users, and issue types
Test Management Test cases, test runs, and execution tracking
Smart Filtering Advanced task and test case filtering
Lookup & Utilities Name-to-ID resolution and cache management

🛠️ Available Tools

Core Management

Tool Purpose Key Parameters
fr_get_project Get project details project_identifier
fr_get_task Get task by ID/key project_identifier, key
fr_get_all_tasks List all project tasks project_identifier
fr_get_epic_tasks Get all tasks under an epic/parent epic_key, include_details, include
fr_get_issue_type_by_name Resolve issue type names issue_type_name
get_task_default_and_custom_fields Get form fields for issue types issue_type_name
fr_search_users Find users by name/email search_text

Test Management

Tool Purpose Key Parameters
fr_list_testcases List all test cases project_identifier
fr_get_testcase Get specific test case test_case_key
fr_get_testcases_by_section Get tests by section section_name
fr_link_testcase_issues Link tests to issues testcase_keys, issue_keys
fr_filter_testcases Advanced test filtering filter_rules
fr_add_testcases_to_testrun Add tests to run test_run_id, test_case_keys
fr_get_testrun_details Get test run insights test_run_id

Smart Filtering

Tool Purpose Key Parameters
fr_filter_tasks Advanced task filtering with native query_hash query_hash, filter_id, include, pagination
fr_get_issue_form_fields Get issue form schema issue_type_id
fr_get_testcase_form_fields Get test form schema -
fr_get_all_issue_type_form_fields Get all form schemas -

Lookup & Utilities

Tool Purpose Key Parameters
fr_get_sprint_by_name Find sprint by name sprint_name
fr_get_release_by_name Find release by name release_name
fr_get_tag_by_name Find tag by name tag_name
fr_get_current_subproject_sprint Get active sub-project sprint sub_project_name
get_subproject_id_by_name Resolve sub-project names sub_project_name
fr_clear_filter_cache Clear filter cache -
fr_clear_all_caches Clear all caches -

✨ Smart Features

  • 🧠 Name-to-ID Resolution: Converts user names, sprint names, issue types, etc. to IDs automatically
  • 📋 Native Query Format: Full support for Freshrelease's query_hash format with all operators
  • 🌲 Hierarchical Sections: Navigate up to 7 levels deep section hierarchies (e.g., "Level1 > Level2 > Level3")
  • 🔄 API Compatibility: Handles both nested {"users": [...]} and direct array response formats
  • ⚡ Performance Optimized: Multi-level caching, connection pooling, optimized batch processing
  • 🔗 Flexible Project IDs: Accept both project keys ("FS") and numeric IDs (123)
  • 🎯 Custom Field Support: Auto-detects and handles custom fields with "cf_" prefixing
  • 📊 Multiple Query Formats: Native query_hash, comma-separated strings, or JSON objects

🚀 Quick Start

1. Install

# Easy install (no Python needed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Or with Python: uv tool install freshrelease-mcp

2. Get Credentials

  • API Key: Freshrelease → Profile → API Key
  • Domain: company.freshrelease.com (your domain)
  • Project Key: e.g., "FS", "PROJ" (optional)

3. Configure Cursor

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "freshrelease-mcp": {
      "command": "uvx",
      "args": ["freshrelease-mcp"],
      "env": {
        "FRESHRELEASE_API_KEY": "your_api_key",
        "FRESHRELEASE_DOMAIN": "company.freshrelease.com",
        "FRESHRELEASE_PROJECT_KEY": "FS"
      }
    }
  }
}

4. Restart Cursor

✅ You'll see Freshrelease tools available!

💡 Usage Examples

🎯 Task Management

Get project overview:

"Show me all tasks in the FS project"

Get specific task details:

"Get details for task FS-123"

Get all tasks under an epic:

"Show me all tasks and their status under epic FS-223786"

The AI will automatically:

  • Fetch the epic details and all child tasks
  • Provide status breakdown and progress summary
  • Show assignee distribution and priority breakdown

📋 Advanced Task Filtering

Use natural language filtering:

"Find all high priority tasks owned by John Doe that are currently in progress"

The AI understands both:

  • Friendly labels: "Owner", "Status", "Priority"
  • Technical names: "owner_id", "status_id", "priority_id"

Native Freshrelease filtering with existing filters:

"Filter tasks using saved filter ID 102776 with custom fields and date ranges"

Sprint and date-based filtering:

"Show me all bugs in Sprint 1 created between Dec 2024 and Aug 2025"

🧪 Test Case Management

Filter test cases naturally:

"Find all high and medium severity functional tests in the Authentication section"

Navigate hierarchical sections:

"Get all test cases from Authentication > Login Tests > Positive Cases section"

The AI can navigate up to 7 levels deep in section hierarchies automatically.

Get test run insights:

"How is test run 150183 performing?"

Response example: "Test run has 8 total tests, all 8 passed successfully. Great job!"

🆕 Latest Updates

v1.8.5 - Epic Management & Enhanced Filtering

  • Epic Task Management: New fr_get_epic_tasks tool to fetch all tasks under an epic with progress summaries
  • Enhanced Field Mapping: Fixed filtering issues with improved field label resolution
  • Better Error Handling: Comprehensive logging and error messages for debugging
  • Issue Key Resolution: Support for parent_id and epic_id filtering using issue keys

v1.8.4 - Filter Bug Fixes

  • Fixed Fields Mapping Error: Resolved "Failed to get project fields mapping: 0" error
  • API Response Handling: Better handling of nested vs. direct array responses
  • Common Field Mappings: Added support for "Parent", "Epic", "Owner" field labels

🔧 Troubleshooting

Not seeing tools in Cursor?

  1. Check ~/.cursor/mcp.json is valid JSON
  2. Restart Cursor completely
  3. Verify credentials: uvx freshrelease-mcp --help

Environment Variables:

FRESHRELEASE_API_KEY="your_api_key"      # Required
FRESHRELEASE_DOMAIN="company.freshrelease.com"  # Required  
FRESHRELEASE_PROJECT_KEY="FS"            # Optional default project

📄 License

MIT License - see LICENSE file for details.


Like this project? Give it a star on GitHub!
🐛 Found a bug? Open an issue
💡 Have ideas? Start a discussion

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

freshrelease_mcp-1.8.9.tar.gz (66.4 kB view details)

Uploaded Source

Built Distribution

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

freshrelease_mcp-1.8.9-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file freshrelease_mcp-1.8.9.tar.gz.

File metadata

  • Download URL: freshrelease_mcp-1.8.9.tar.gz
  • Upload date:
  • Size: 66.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.18

File hashes

Hashes for freshrelease_mcp-1.8.9.tar.gz
Algorithm Hash digest
SHA256 848c1ad6ae7f2e3b586fea4b87554b040af58309031189a3bb649ff0f91f5066
MD5 2a559a4d3d8370d46bc86c06c3f027b6
BLAKE2b-256 6f8307d2c2408e1f40869598875fbcb868933c980a21e6251e9a8fd2d5043737

See more details on using hashes here.

File details

Details for the file freshrelease_mcp-1.8.9-py3-none-any.whl.

File metadata

File hashes

Hashes for freshrelease_mcp-1.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 94e667533bbb932431be0adb583f73669638d869f8b9c81a81e8025b2181665c
MD5 a4be9bd022781866ae50c126cf05f177
BLAKE2b-256 cf73c5ec623e94a007b1c36034c4d98d835aa50b2b674d63412e09cfb8cc83e6

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