backlog-mcp-server

# Backlog MCP Server This is an MCP Server that provides access to the Backlog API. You can use functions such as project management, issue tracking, and file operations. ## Features - **Project Management**: Get project list, view details - **Issue Management**: Create, update, search issues, add comments - **User Management**: Get user information - **File Operations**: Manage attachments - **Comment Function**: Add comments to issues - **Search Function**: Search for issues and projects ## Tools ### Project Related #### getSpaces - Get space information - Input: None - Return value: Space information #### getProjects - Get project list - Input: None - Return value: Project list ### Issue Related #### getIssues - Get issue list - Input: - projectIdOrKey (string): Project ID or key - offset (number, optional): Acquisition start position - count (number, optional): Number of items to acquire (maximum 100) - sort (string, optional): Sort order ('created' or 'updated') - order (string, optional): Sort direction ('asc' or 'desc') - Return value: Issue list #### getIssue - Get issue details - Input: - issueIdOrKey (string): Issue ID or key - Return value: Issue details #### createIssue - Create a new issue - Input: - projectId (string/number): Project ID - summary (string): Issue subject - issueTypeId (string/number): Issue type ID - priorityId (string/number, optional): Priority ID - description (string, optional): Issue details - startDate (string, optional): Start date (YYYY-MM-DD format) - dueDate (string, optional): Due date (YYYY-MM-DD format) - assigneeId (string/number, optional): Assignee ID - Return value: Information of the created issue #### updateIssue - Update an existing issue - Input: - issueIdOrKey (string): Issue ID or key - summary (string, optional): Issue subject - description (string, optional): Issue details - statusId (string/number, optional): Status ID - priorityId (string/number, optional): Priority ID - assigneeId (string/number, optional): Assignee ID - startDate (string, optional): Start date (YYYY-MM-DD format) - dueDate (string, optional): Due date (YYYY-MM-DD format) - Return value: Information of the updated issue #### addComment - Add a comment to an issue - Input: - issueIdOrKey (string): Issue ID or key - content (string): Comment content - Return value: Information of the added comment ### Search Related #### searchIssues - Search for issues - Input: - keyword (string): Search keyword - projectIdOrKey (string, optional): Project ID or key - offset (number, optional): Acquisition start position - count (number, optional): Number of items to acquire (maximum 100) - Return value: Issue list of search results ## Search Syntax ### Issue Search - `keyword`: Free text search - `projectId`: Narrow down by specific project - `statusId`: Narrow down by status - `assigneeId`: Narrow down by assignee Example: `keyword=bug statusId=1 assigneeId=12345` ## Setup ### Get API Key 1. Log in to Backlog 2. Personal Settings > API > Issue API Key 3. Copy the issued API key ### Set Environment Variables Add the following settings to the `.env` file: ``` BACKLOG_DOMAIN=your-domain.backlog.com BACKLOG_API_KEY=your-api-key # Test settings (optional) TEST_PROJECT_ID=your-test-project-id TEST_PROJECT_KEY=your-test-project-key ``` ### Using with Claude Desktop To use with Claude Desktop, add the following to `claude_desktop_config.json`: #### NPX Case ```json { "mcpServers": { "backlog": { "command": "npx", "args": ["-y", "@tmhr1850/backlog-mcp-server"], "env": { "BACKLOG_DOMAIN": "your-domain.backlog.com", "BACKLOG_API_KEY": "your-api-key" } } } } ``` ### Local Execution ```bash # Build npm run build # Execute npm start ``` ## Test ```bash # Execute all tests npm test # Execute tests in watch mode npm run test:watch # Execute tests with coverage report npm run test:coverage ``` ## License This MCP Server is provided under the MIT License. See the LICENSE file in the project repository for details.