@aashari/mcp-server-atlassian-jira
Version:
Node.js/TypeScript MCP server for Atlassian Jira. Equips AI systems (LLMs) with tools to list/get projects, search/get issues (using JQL/ID), and view dev info (commits, PRs). Connects AI capabilities directly into Jira project management and issue tracki
137 lines (131 loc) • 7.03 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const logger_util_js_1 = require("../utils/logger.util.js");
const error_util_js_1 = require("../utils/error.util.js");
const atlassian_projects_controller_js_1 = __importDefault(require("../controllers/atlassian.projects.controller.js"));
const formatter_util_js_1 = require("../utils/formatter.util.js");
/**
* CLI module for managing Jira projects.
* Provides commands for listing projects and retrieving project details.
* All commands require valid Atlassian credentials.
*/
// Create a contextualized logger for this file
const cliLogger = logger_util_js_1.Logger.forContext('cli/atlassian.projects.cli.ts');
// Log CLI module initialization
cliLogger.debug('Jira projects CLI module initialized');
/**
* Register Jira Projects CLI commands with the Commander program
* @param program - The Commander program instance to register commands with
* @throws Error if command registration fails
*/
function register(program) {
const methodLogger = logger_util_js_1.Logger.forContext('cli/atlassian.projects.cli.ts', 'register');
methodLogger.debug('Registering Jira Projects CLI commands...');
registerListProjectsCommand(program);
registerGetProjectCommand(program);
methodLogger.debug('CLI commands registered successfully');
}
/**
* Register the command for listing Jira projects
* @param program - The Commander program instance
*/
function registerListProjectsCommand(program) {
program
.command('list-projects')
.description(`List Jira projects with pagination and optional filtering.
PURPOSE: Browse all accessible Jira projects for discovery, exploration, and finding project keys/IDs.
Use Case: Get an overview of all Jira projects you have access to, with essential metadata including key, name, type, and lead. Useful for finding project keys needed for more specific operations.
Output: Formatted list of projects with key, name, type, and lead information. Includes pagination support for large project collections.
Examples:
$ mcp-atlassian-jira list-projects --limit 10
$ mcp-atlassian-jira list-projects --name "Marketing" --limit 25 --cursor "25"
$ mcp-atlassian-jira list-projects --order-by "key"`)
.option('-l, --limit <number>', 'Maximum number of items to return (1-100)', '25')
.option('-c, --cursor <string>', 'Pagination cursor for retrieving the next set of results')
.option('--name <name>', 'Filter projects by name or key (case-insensitive)')
.option('--order-by <field>', 'Sort projects by field (e.g., key, name, lastIssueUpdatedTime)')
.action(async (options) => {
const actionLogger = logger_util_js_1.Logger.forContext('cli/atlassian.projects.cli.ts', 'list-projects');
try {
actionLogger.debug('Processing command options:', options);
// Validate limit if provided
if (options.limit) {
const limit = parseInt(options.limit, 10);
if (isNaN(limit) || limit <= 0) {
throw new Error('Invalid --limit value: Must be a positive integer.');
}
}
// Validate sort if provided - only allow valid sort fields
if (options.orderBy &&
!['key', 'name', '-key', '-name'].includes(options.orderBy)) {
throw new Error('Invalid --order-by value: Must be one of: key, name, -key, -name.');
}
// Validate name value format if provided
if (options.name && typeof options.name !== 'string') {
throw new Error('Invalid --name value: Must be a valid search string.');
}
const filterOptions = {
...(options.name && { name: options.name }),
...(options.limit && {
limit: parseInt(options.limit, 10),
}),
...(options.cursor && { cursor: options.cursor }),
...(options.orderBy && { orderBy: options.orderBy }),
};
actionLogger.debug('Fetching projects with filters:', filterOptions);
const result = await atlassian_projects_controller_js_1.default.list(filterOptions);
actionLogger.debug('Successfully retrieved projects');
// Print the main content
console.log((0, formatter_util_js_1.formatHeading)('Projects', 2));
console.log(result.content);
// Print pagination information if available
if (result.pagination) {
// Use the actual number of items displayed rather than potentially zero count
// The count comes from the controller - it should be the number of items in the current batch
// We extract this from the controller response.
// If the response has no items but has more results, show 0 but indicate more are available
const displayCount = result.pagination.count ?? 0;
console.log('\n' +
(0, formatter_util_js_1.formatPagination)(displayCount, result.pagination.hasMore, result.pagination.nextCursor));
}
}
catch (error) {
actionLogger.error('Operation failed:', error);
(0, error_util_js_1.handleCliError)(error);
}
});
}
/**
* Register the command for retrieving a specific Jira project
* @param program - The Commander program instance
*/
function registerGetProjectCommand(program) {
program
.command('get-project')
.description(`Get detailed information about a specific Jira project using its key or ID.
PURPOSE: Retrieve comprehensive metadata for a *known* project, including its full description, lead, components, versions, style, and links.`)
.requiredOption('--project-key-or-id <keyOrId>', 'Key or numeric ID of the project to retrieve (e.g., "TEAM" or "10001")')
.action(async (options) => {
const actionLogger = logger_util_js_1.Logger.forContext('cli/atlassian.projects.cli.ts', 'get-project');
try {
actionLogger.debug('Processing command options:', options);
// Validate project key/ID
if (!options.projectKeyOrId ||
options.projectKeyOrId.trim() === '') {
throw new Error('Project key or ID must not be empty.');
}
actionLogger.debug(`Fetching project: ${options.projectKeyOrId}`);
const result = await atlassian_projects_controller_js_1.default.get({
projectKeyOrId: options.projectKeyOrId,
});
console.log(result.content);
}
catch (error) {
(0, error_util_js_1.handleCliError)(error);
}
});
}
exports.default = { register };