mcp-server-spira


Namemcp-server-spira JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/Inflectra/mcp-server-spira
SummaryA Model Context Protocol (MCP) server enabling AI assistants to interact with Spira by Inflectra.
upload_time2025-07-10 21:42:11
maintainerNone
docs_urlNone
authorInflectra Corporation
requires_python>=3.12
licenseNone
keywords mcp ai genai
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MCP Inflectra Spira Server
A Model Context Protocol (MCP) server enabling AI assistants to interact with Spira by Inflectra.

## Overview
This project implements a Model Context Protocol (MCP) server that allows AI assistants (like Claude) to interact with the Inflectra Spira platform, providing a bridge between natural language interactions and the Spira REST API.

This server supports all three editions of Spira:
- **SpiraTest:** Test Management When You Need Quality, Agility & Speed 
- **SpiraTeam:** Project, Requirements Management & ALM For Agile Teams 
- **SpiraPlan:** Program Management & ALM For Scaling Agile & Enterprises   


## Features
The Spira MCP server current implements the following features:

### My Work
This feature provides easy access to the list of artifacts that have been assigned to the current user

- **My Tasks:** Provides operations for working with the Spira tasks I have been assigned
- **My Requirements:** Provides operations for working with the Spira requirements I have been assigned
- **My Incidents:** Provides operations for working with the Spira incidents I have been assigned
- **My Test Cases:** Provides operations for working with the Spira test cases I have been assigned
- **My Test Sets:** Provides operations for working with the Spira test sets I have been assigned

### Workspaces
This feature provides tools that let you retrieve and modify the different workspaces inside Spira

- **Programs:** Provides operations for working with Spira programs
- **Products:** Provides operations for working with Spira products
- **Product Templates:** Provides operations for working with Spira product templates

### Program Artifacts
This feature provides tools that let you retrieve and modify the different artifacts inside a Spira program

- **Capabilities:** Provides operations for working with the Spira capabilities in a program backlog
- **Milestones:** Provides operations for working with the Spira milestones in a program

### Product Artifacts
This feature provides tools that let you retrieve and modify the different artifacts inside a Spira product

- **Requirements:** Provides operations for working with the Spira requirements in a product
- **Releases:** Provides operations for working with the Spira releases in a product
- **Test Cases:** Provides operations for working with the Spira test case folders and test cases in a product
- **Test Sets:** Provides operations for working with the Spira test set folders and test sets in a product
- **Test Runs:** Provides operations for working with the Spira test runs in a product
- **Tasks:** Provides operations for working with the Spira tasks in a product
- **Incidents:** Provides operations for working with the Spira incidents (e.g. bugs, enhancements, issues, etc.) in a product
- **Automation Hosts:** Provides operations for working with the Spira automation hosts in a product

### Template Configuration
This feature provides tools that let you view and modify the configuration and settings of Spira product templates

- **Artifact Types:** Retrieves information on the artifact types in a product template, and their sub-types
- **Custom Properties:** Retrieves information on the artifact types in a product template, and their custom properties

### Automation
This feature provides tools that let you integrate automated DevOps tools such as test automation frameworks and CI/CD pipelines

- **Automated Test Runs:** Provides operations for recording automated test run results into Spira
- **Builds:** Provides operations for recording the results of CI/CD builds into Spira

## Getting Started

### Prerequisites

- Python 3.10+
- Inflectra Spira cloud account with appropriate permissions
- Username and active API Key (RSS Token) for this instance

### Installation

```bash
# Clone the repository
git clone https://github.com/Inflectra/mcp-server-spira.git
cd mcp-server-spira

# Install in development mode
uv pip install -e ".[dev]"

# Install from PyPi
pip install mcp-server-spira
```

### Configuration

Create a `.env` file in the project root with the following variables:

```
INFLECTRA_SPIRA_BASE_URL=The base URL for your instance of Spira (typically https://mycompany.spiraservice.net or https://demo-xx.spiraservice.net/mycompany)
INFLECTRA_SPIRA_USERNAME=The login name you use to access Spira
INFLECTRA_SPIRA_API_KEY=The API Key (RSS Token) you use to access the Spira REST API
```

Note: Make sure your API Key is active and saved in your Spira user profile.

### Running the Server

```bash
# Development mode with the MCP Inspector
mcp dev src/mcp_server_spira/server.py

# Production mode using shell / command line
python -m mcp_server_spira

# Install in Claude Desktop
mcp install src/mcp_server_spira/server.py --name "Inflectra Spira Server"
```

## Usage Examples

### Get Assigned Artifacts

```
Get me my assigned tasks in Spira/
```

```
Get me my assigned requirements in Spira/
```


### View Project Structure

```
List all projects in my organization and show me the iterations for the Development team
```

## Development

The project is structured into feature modules, each implementing specific Inflectra Spira capabilities:

- `features/mywork`: Accessing a user's assigned artifacts and updating their status/progress
- `features/projects`: Project management capabilities
- `features/programs`: Program management features
- `utils`: Common utilities and client initialization

For more information on development, see the [CLAUDE.md](CLAUDE.md) file.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- Built with [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
- Uses [Inflectra Spira v7.0 REST API](https://spiradoc.inflectra.com/Developers/API-Overview/)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Inflectra/mcp-server-spira",
    "name": "mcp-server-spira",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "MCP, AI, GenAI",
    "author": "Inflectra Corporation",
    "author_email": "support@inflectra.com",
    "download_url": "https://files.pythonhosted.org/packages/b0/2f/c413713d4fc3ade8abc3981c7de80e707d96ff755a9ed2646a41c4067ee4/mcp_server_spira-1.0.1.tar.gz",
    "platform": null,
    "description": "# MCP Inflectra Spira Server\r\nA Model Context Protocol (MCP) server enabling AI assistants to interact with Spira by Inflectra.\r\n\r\n## Overview\r\nThis project implements a Model Context Protocol (MCP) server that allows AI assistants (like Claude) to interact with the Inflectra Spira platform, providing a bridge between natural language interactions and the Spira REST API.\r\n\r\nThis server supports all three editions of Spira:\r\n- **SpiraTest:** Test Management When You Need Quality, Agility & Speed \r\n- **SpiraTeam:** Project, Requirements Management & ALM For Agile Teams \r\n- **SpiraPlan:** Program Management & ALM For Scaling Agile & Enterprises   \r\n\r\n\r\n## Features\r\nThe Spira MCP server current implements the following features:\r\n\r\n### My Work\r\nThis feature provides easy access to the list of artifacts that have been assigned to the current user\r\n\r\n- **My Tasks:** Provides operations for working with the Spira tasks I have been assigned\r\n- **My Requirements:** Provides operations for working with the Spira requirements I have been assigned\r\n- **My Incidents:** Provides operations for working with the Spira incidents I have been assigned\r\n- **My Test Cases:** Provides operations for working with the Spira test cases I have been assigned\r\n- **My Test Sets:** Provides operations for working with the Spira test sets I have been assigned\r\n\r\n### Workspaces\r\nThis feature provides tools that let you retrieve and modify the different workspaces inside Spira\r\n\r\n- **Programs:** Provides operations for working with Spira programs\r\n- **Products:** Provides operations for working with Spira products\r\n- **Product Templates:** Provides operations for working with Spira product templates\r\n\r\n### Program Artifacts\r\nThis feature provides tools that let you retrieve and modify the different artifacts inside a Spira program\r\n\r\n- **Capabilities:** Provides operations for working with the Spira capabilities in a program backlog\r\n- **Milestones:** Provides operations for working with the Spira milestones in a program\r\n\r\n### Product Artifacts\r\nThis feature provides tools that let you retrieve and modify the different artifacts inside a Spira product\r\n\r\n- **Requirements:** Provides operations for working with the Spira requirements in a product\r\n- **Releases:** Provides operations for working with the Spira releases in a product\r\n- **Test Cases:** Provides operations for working with the Spira test case folders and test cases in a product\r\n- **Test Sets:** Provides operations for working with the Spira test set folders and test sets in a product\r\n- **Test Runs:** Provides operations for working with the Spira test runs in a product\r\n- **Tasks:** Provides operations for working with the Spira tasks in a product\r\n- **Incidents:** Provides operations for working with the Spira incidents (e.g. bugs, enhancements, issues, etc.) in a product\r\n- **Automation Hosts:** Provides operations for working with the Spira automation hosts in a product\r\n\r\n### Template Configuration\r\nThis feature provides tools that let you view and modify the configuration and settings of Spira product templates\r\n\r\n- **Artifact Types:** Retrieves information on the artifact types in a product template, and their sub-types\r\n- **Custom Properties:** Retrieves information on the artifact types in a product template, and their custom properties\r\n\r\n### Automation\r\nThis feature provides tools that let you integrate automated DevOps tools such as test automation frameworks and CI/CD pipelines\r\n\r\n- **Automated Test Runs:** Provides operations for recording automated test run results into Spira\r\n- **Builds:** Provides operations for recording the results of CI/CD builds into Spira\r\n\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\n- Python 3.10+\r\n- Inflectra Spira cloud account with appropriate permissions\r\n- Username and active API Key (RSS Token) for this instance\r\n\r\n### Installation\r\n\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/Inflectra/mcp-server-spira.git\r\ncd mcp-server-spira\r\n\r\n# Install in development mode\r\nuv pip install -e \".[dev]\"\r\n\r\n# Install from PyPi\r\npip install mcp-server-spira\r\n```\r\n\r\n### Configuration\r\n\r\nCreate a `.env` file in the project root with the following variables:\r\n\r\n```\r\nINFLECTRA_SPIRA_BASE_URL=The base URL for your instance of Spira (typically https://mycompany.spiraservice.net or https://demo-xx.spiraservice.net/mycompany)\r\nINFLECTRA_SPIRA_USERNAME=The login name you use to access Spira\r\nINFLECTRA_SPIRA_API_KEY=The API Key (RSS Token) you use to access the Spira REST API\r\n```\r\n\r\nNote: Make sure your API Key is active and saved in your Spira user profile.\r\n\r\n### Running the Server\r\n\r\n```bash\r\n# Development mode with the MCP Inspector\r\nmcp dev src/mcp_server_spira/server.py\r\n\r\n# Production mode using shell / command line\r\npython -m mcp_server_spira\r\n\r\n# Install in Claude Desktop\r\nmcp install src/mcp_server_spira/server.py --name \"Inflectra Spira Server\"\r\n```\r\n\r\n## Usage Examples\r\n\r\n### Get Assigned Artifacts\r\n\r\n```\r\nGet me my assigned tasks in Spira/\r\n```\r\n\r\n```\r\nGet me my assigned requirements in Spira/\r\n```\r\n\r\n\r\n### View Project Structure\r\n\r\n```\r\nList all projects in my organization and show me the iterations for the Development team\r\n```\r\n\r\n## Development\r\n\r\nThe project is structured into feature modules, each implementing specific Inflectra Spira capabilities:\r\n\r\n- `features/mywork`: Accessing a user's assigned artifacts and updating their status/progress\r\n- `features/projects`: Project management capabilities\r\n- `features/programs`: Program management features\r\n- `utils`: Common utilities and client initialization\r\n\r\nFor more information on development, see the [CLAUDE.md](CLAUDE.md) file.\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Acknowledgments\r\n\r\n- Built with [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)\r\n- Uses [Inflectra Spira v7.0 REST API](https://spiradoc.inflectra.com/Developers/API-Overview/)\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Model Context Protocol (MCP) server enabling AI assistants to interact with Spira by Inflectra.",
    "version": "1.0.1",
    "project_urls": {
        "Documentation": "https://www.inflectra.com/Ideas/Entry/using-the-spira-mcp-server-in-vs-code-part-1-1902.aspx",
        "Homepage": "https://github.com/Inflectra/mcp-server-spira",
        "Repository": "https://github.com/Inflectra/mcp-server-spira.git"
    },
    "split_keywords": [
        "mcp",
        " ai",
        " genai"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ab28bcfc57ad13db92a583cea69520c72d7127ae04de79d4faa727e4d78720c2",
                "md5": "f07bd33743a2a057da7b26eacc847b90",
                "sha256": "fa072b1129b895f0b53657140b839cf4726a4fd8a1131ebfe407870134d29934"
            },
            "downloads": -1,
            "filename": "mcp_server_spira-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f07bd33743a2a057da7b26eacc847b90",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 46179,
            "upload_time": "2025-07-10T21:42:10",
            "upload_time_iso_8601": "2025-07-10T21:42:10.018892Z",
            "url": "https://files.pythonhosted.org/packages/ab/28/bcfc57ad13db92a583cea69520c72d7127ae04de79d4faa727e4d78720c2/mcp_server_spira-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b02fc413713d4fc3ade8abc3981c7de80e707d96ff755a9ed2646a41c4067ee4",
                "md5": "75708b68c08ce67345a93a7f5963b27b",
                "sha256": "8a65376a0749b882cf8ce1d6f2b060e8119eeb542d67e3a980a8aacaaaadbf96"
            },
            "downloads": -1,
            "filename": "mcp_server_spira-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "75708b68c08ce67345a93a7f5963b27b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 25572,
            "upload_time": "2025-07-10T21:42:11",
            "upload_time_iso_8601": "2025-07-10T21:42:11.178812Z",
            "url": "https://files.pythonhosted.org/packages/b0/2f/c413713d4fc3ade8abc3981c7de80e707d96ff755a9ed2646a41c4067ee4/mcp_server_spira-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 21:42:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Inflectra",
    "github_project": "mcp-server-spira",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mcp-server-spira"
}
        
Elapsed time: 0.42510s