Pytaiga MCP

🚀 MCP Proxy Server for Taiga Integration

This is an MCP proxy server designed for integration with the Taiga platform, supporting interactive operations via the MCP protocol.

✨ Features

• MCP Compatibility: Fully adheres to the MCP protocol specifications.
• Authentication and Authorization: Supports user authentication and permission management.
• Project Management: Implements CRUD operations for Taiga projects.
• Task Tracking: Supports the creation and tracking of tasks such as Epics and User Stories.
• Performance Optimization: Includes connection pooling, rate limiting, and retry mechanisms.

📦 Installation

Quick Installation

Use the following command to quickly install the project:

pip install taiga-mcp-proxy

Installation from Source Code

1. Clone the repository:

   git clone https://github.com/yourusername/pyTaigaMCP.git
   cd pyTaigaMCP
   

2. Install dependencies:

   ./install.sh
   

💻 Usage Examples

Basic Usage

Initialize the MCP Client

from mcp.client import Client

client = Client()

Authentication and Session Management

1. User Authentication:

auth_result = client.call_tool("login", {
    "username": "admin",
    "password": "password123"
})
session_id = auth_result["session_id"]

2. Project Creation:

project = client.call_tool("create_project", {
    "session_id": session_id,
    "name": "My Project",
    "description": "A new Taiga project"
})

3. Create an Epic:

epic = client.call_tool("create_epic", {
    "session_id": session_id,
    "project_id": project_id,
    "subject": "New Feature",
    "description": "Implement new user feature"
})

4. Create a User Story:

story = client.call_tool("create_user_story", {
    "session_id": session_id,
    "project_id": project_id,
    "subject": "Login Functionality",
    "description": "Add user login functionality",
    "epic_id": epic_id
})

5. Query Session Status:

status = client.call_tool("session_status", {"session_id": session_id})

6. User Logout:

client.call_tool("logout", {"session_id": session_id})

Advanced Usage

Example: Create a Project and Add Tasks

1. Initialize the Client:

client = Client()

2. User Login:

auth_result = client.call_tool("login", {
    "username": "admin",
    "password": "secret"
})
session_id = auth_result["session_id"]

3. Create a Project:

project = client.call_tool("create_project", {
    "session_id": session_id,
    "name": "New Project",
    "description": "A new Taiga project"
})

4. Create an Epic:

epic = client.call_tool("create_epic", {
    "session_id": session_id,
    "project_id": project.id,
    "subject": "New Feature",
    "description": "Implement new user feature"
})

5. Create a User Story:

story = client.call_tool("create_user_story", {
    "session_id": session_id,
    "project_id": project.id,
    "subject": "Login Functionality",
    "description": "Add user login functionality",
    "epic_id": epic.id
})

📚 Documentation

Project Structure

pyTaigaMCP/
├── src/
│   ├── server.py          # MCP server implementation, including utility methods
│   ├── taiga_client.py    # Taiga API client, providing CRUD operations
│   ├── tools.py           # MCP tool definitions
│   └── config.py          # Configuration settings, managed by Pydantic
├── tests/
│   ├── conftest.py        # Shared pytest fixtures
│   ├── unit/              # Unit tests
│   └── integration/       # Integration tests
├── pyproject.toml         # Project configuration and dependency management
├── install.sh             # Installation script
├── run.sh                 # Server execution script
└── README.md              # Project documentation

Testing

Run tests using pytest:

# Run all tests
pytest

# Run unit tests
cd tests && pytest unit/

# Perform test coverage check
coverage run -m pytest && coverage report

Error Handling

Common Errors

1. Authentication Failure:

Error: Authentication failed, invalid credentials

2. Insufficient Permissions:

Error: Permission denied, insufficient privileges

3. Project Not Found:

Error: Project not found with given ID

FAQ

Q: How to handle session timeouts?

A: Call the session_status tool to check the session status. If it has expired, log in again.

Q: Can it be integrated into an existing system?

A: This project provides support for RESTful API and MCP protocol, which can be easily integrated with existing systems.

Contribution Guidelines

1. Fork the project repository.
2. Create a feature branch.
3. Submit your code and create a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.