MCP Atlassian
Un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona herramientas para interactuar con los productos de Atlassian (Confluence y Jira).
Descripción general
Este servidor MCP permite a los agentes de IA interactuar con los productos de Atlassian a través de una interfaz estandarizada. Proporciona herramientas para:
- Confluence : busca contenido, obtén espacios, recupera contenido y enumera páginas
- Jira : buscar problemas, obtener detalles de problemas, enumerar proyectos y más
Prerrequisitos
- Node.js (v16 o superior)
- npm o hilo
- Cuenta Atlassian con token API
- Docker (opcional, para implementación en contenedores)
Instalación
Instalación estándar
- Clonar el repositorio:
git clone https://github.com/yourusername/mcp-atlassian.git
cd mcp-atlassian
- Instalar dependencias:
npm install
# or using make
make install
- Cree un archivo
.env en el directorio raíz con sus credenciales de Atlassian:ATLASSIAN_HOST=https://your-domain.atlassian.net
ATLASSIAN_EMAIL=your-email@example.com
ATLASSIAN_API_TOKEN=your-api-token
Instalación de Docker
- Clonar el repositorio:
git clone https://github.com/yourusername/mcp-atlassian.git
cd mcp-atlassian
- Cree un archivo
.env como se describe arriba. - Construya y ejecute el contenedor Docker:
# Build the Docker image
make docker-build
# Run the Docker container
make docker-run
# Or use Docker Compose
make docker-compose
Uso
Iniciando el servidor
# Using npm
npm start
# Using make
make start
# Using Docker
make docker-run
Esto iniciará el servidor MCP, que escuchará las solicitudes en la entrada estándar y responderá en la salida estándar.
Herramientas disponibles
Herramientas de Confluence
- search-confluence : Busca contenido en Confluence usando CQL
- Parámetros:
query (cadena)
- get-confluence-space : obtener información sobre un espacio de Confluence específico
- Parámetros:
spaceKey (cadena)
- get-confluence-content : Obtener contenido específico por ID
- Parámetros:
contentId (cadena)
- get-confluence-pages : Obtener todas las páginas de un espacio
- Parámetros:
spaceKey (cadena), limit (número, opcional)
Herramientas de Jira
- search-jira-issues : Buscar problemas usando JQL
- Parámetros:
jql (cadena), maxResults (número, opcional)
- get-jira-issue : Obtener un problema específico por clave
- Parámetros:
issueKey (cadena)
- get-jira-projects : Obtener todos los proyectos
- get-jira-project : Obtener un proyecto específico por clave
- Parámetros:
projectKey (cadena)
- get-jira-issue-types : Obtener todos los tipos de problemas
Desarrollo
Estructura del proyecto
src/
├── config/ # Configuration files
├── examples/ # Example usage
├── services/ # Service classes for Atlassian APIs
│ ├── confluence.ts
│ └── jira.ts
├── tools/ # MCP tools
│ ├── search-confluence.ts
│ ├── get-confluence-space.ts
│ ├── get-confluence-content.ts
│ ├── get-confluence-pages.ts
│ ├── search-jira-issues.ts
│ ├── get-jira-issue.ts
│ ├── get-jira-projects.ts
│ ├── get-jira-project.ts
│ ├── get-jira-issue-types.ts
│ ├── utils.ts
│ └── index.ts
└── index.ts # Main entry point
Edificio
# Using npm
npm run build
# Using make
make build
Pruebas
# Using npm
npm test
# Using make
make test
Comandos de Makefile
El proyecto incluye un Makefile para simplificar las operaciones comunes:
# Display available commands
make help
Licencia
Instituto Tecnológico de Massachusetts (MIT)
Contribuyendo
- Bifurcar el repositorio
- Crea tu rama de funciones (
git checkout -b feature/amazing-feature ) - Confirme sus cambios (
git commit -m 'Add some amazing feature' ) - Empujar a la rama (
git push origin feature/amazing-feature ) - Abrir una solicitud de extracción