logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

backlog-api-gateway

Unified access point for leveraging Backlog's project administration, issue tracking capabilities, and digital asset management via its established REST interface. Facilitates robust handling of projects, tasks, personnel records, and uploaded binaries within consuming systems.

Author

backlog-api-gateway logo

tmhr1850

MIT License

Quick Info

GitHub GitHub Stars 12
NPM Weekly Downloads 63921
Tools 1
Last Updated 2026-02-19

Tags

backlogtmhr1850toolstmhr1850 backlogintegration backlogbacklog api

Backlog API Gateway Service

This MCP server establishes a consolidated interface for interacting with the Backlog Platform API, providing programmatic control over core organizational management functions.

Core Capabilities

  • Project Governance: Retrieve directory structures and in-depth metadata for organizational units.
  • Task Lifecycle Management: Execute creation, modification, querying, and annotation of discrete work items.
  • Personnel Indexing: Fetch profiles and details for registered users.
  • Asset Handling: Manage associated file attachments.
  • Annotation System: Inject contextual commentary onto specific work records.
  • Discovery Engine: Perform targeted searches across tasks and projects.

Exposed Endpoints

Project Operations

fetchSpaces

  • Retrieves organizational space metadata.
  • Parameters: None
  • Returns: Space configuration objects.

listProjects

  • Fetches a catalog of all accessible projects.
  • Parameters: None
  • Returns: An array of project entities.

Issue/Task Operations

retrieveIssues

  • Fetches a paginated list of work items.
  • Parameters:
  • projectIdOrKey (string): Identifier (ID or key) of the parent project.
  • offset (number, Optional): Starting index for retrieval.
  • count (number, Optional): Maximum number of records to return (capped at 100).
  • sort (string, Optional): Field criterion for ordering ('created' or 'updated').
  • order (string, Optional): Direction of sorting ('asc' or 'desc').
  • Returns: A collection of issue records.

getSpecificIssue

  • Retrieves granular details for a single work item.
  • Parameters:
  • issueIdOrKey (string): Unique identifier (ID or key) of the task.
  • Returns: The comprehensive issue detail object.

provisionNewIssue

  • Establishes a new work item within the system.
  • Parameters:
  • projectId (string/number): Target project ID.
  • summary (string): Concise title of the task.
  • issueTypeId (string/number): Identifier for the type classification.
  • priorityId (string/number, Optional): Ranking level assignment.
  • description (string, Optional): Detailed narrative content.
  • startDate (string, Optional): Planned commencement date (Format: YYYY-MM-DD).
  • dueDate (string, Optional): Target completion deadline (Format: YYYY-MM-DD).
  • assigneeId (string/number, Optional): Personnel designated for ownership.
  • Returns: The newly created issue entity.

modifyExistingIssue

  • Applies updates to an existing work item's attributes.
  • Parameters:
  • issueIdOrKey (string): Identifier for the task to be altered.
  • summary (string, Optional): New subject line.
  • description (string, Optional): Revised body content.
  • statusId (string/number, Optional): Transition to a new workflow state ID.
  • priorityId (string/number, Optional): Reassignment of importance level.
  • assigneeId (string/number, Optional): Change of responsible party.
  • startDate (string, Optional): Revised start date (YYYY-MM-DD).
  • dueDate (string, Optional): Revised due date (YYYY-MM-DD).
  • Returns: The updated issue record.

ingestComment

  • Appends a textual note to a specified task.
  • Parameters:
  • issueIdOrKey (string): Identifier of the task receiving the annotation.
  • content (string): The textual body of the comment.
  • Returns: Information about the newly appended comment.

Search Functionality

executeIssueSearch

  • Conducts targeted retrieval of tasks based on specified criteria.
  • Parameters:
  • keyword (string): Unrestricted text string for full-text matching.
  • projectIdOrKey (string, Optional): Scope the search to a particular project.
  • offset (number, Optional): Record offset for pagination.
  • count (number, Optional): Maximum result count (limit 100).
  • Returns: The list of issues matching the search parameters.

Query Syntax Reference

Task Filtering Logic

  • keyword: General lexicon search across relevant fields.
  • projectId: Constraint to records within a specific organizational container.
  • statusId: Filter by current workflow state.
  • assigneeId: Restrict results to tasks assigned to a specific individual.

Example Query: keyword=error statusId=5 assigneeId=56789

Deployment Prerequisites

Obtaining API Credentials

  1. Authenticate with your Backlog instance.
  2. Navigate to Personal Settings > API Access.
  3. Generate and record the unique API Token.

Environment Variable Configuration

Configure the runtime environment, typically via a .env file, with the following mandatory settings:

BACKLOG_DOMAIN=your-instance-name.backlog.com BACKLOG_API_KEY=your-generated-secret-token

Optional Overrides for Testing

TEST_PROJECT_ID=P123 TEST_PROJECT_KEY=PROJKEY

Integration with Claude Desktop

To enable operation within the Claude Desktop environment, augment your claude_desktop_config.json file as follows:

NPX Invocation Method

{ "mcpServers": { "backlogProxy": { "command": "npx", "args": ["-y", "@tmhr1850/backlog-mcp-server"], "env": { "BACKLOG_DOMAIN": "your-instance-name.backlog.com", "BACKLOG_API_KEY": "your-generated-secret-token" } } } }

Local Execution Commands

bash

Compile source code

npm run build

Initiate service operation

npm start

Automated Validation

bash

Execute complete test suite

npm test

Run tests continuously upon file changes

npm run test:watch

Generate detailed test coverage report

npm run test:coverage

This intermediary server component is distributed under the permissive MIT License. Refer to the LICENSE file within the source repository for complete terms.

WIKIPEDIA: Business management tools are all the systems, applications, controls, calculating solutions, methodologies, etc. used by organizations to be able to cope with changing markets, ensure a competitive position in them and improve business performance.

== Overview == There are tools related to each organization's department which can be classified for each aspect of management. For example: planning tools, process tools, records tools, employee related tools, decision making tools, control tools, etc. A classification by function would consider these general aspects:

Tools used for data input and validation in any department. Tools used for controlling and improving business processes. Tools used for data consolidation and decision making. Nowadays, management tools have evolved dramatically in the last decade thanks to fast technology advances, so fast that it is difficult to select the best business tools for any situation in any company. This is caused by a never-ending fight for lower costs and increase sales, the willingness for understanding the customers' needs, and the fight for delivering the products that meet their need in the way they require. Under this scenario, managers should take a strategic attitude to business management tools instead of going for the latest tool. Usually, managers rely on the tools without any adaptation which leads to an unstable situation. Business management tools should be selected carefully, and then adapted to the organization needs and not the other way around.

== Most used == In 2013, a survey conducted by Bain & Company showed how business tools are used around the globe. These tools reflect how their outcomes contribute to each region's needs, considering the downfall and companies' market situation. The top ten includes:

Strategic planning Customer relationship management Employee engagement surveys Benchmarking Balanced scorecard Core competency Outsourcing Change management programs Supply chain management Mission statement and vision statement Market segmentation Total quality management

== Software application for businesses == Software or collection of computer programs used by business users to carry out various business operations is referred to as business software (or a business application). These business applications are used to boost output, gauge output, and carry out various other company tasks precisely. It started with management information systems and extended into enterprise resource planning systems. Then customer relationship management was added to the solution and finally the whole package moved into the cloud business management space. Although there is an actual correlation between IT efforts and the organizations' performance, two elements are key to add value to the sum; these are the implementation's effectiveness and the proper tools selections and adaptation process.

== Tools for SMEs == The tools focused on SMEs are important because they provide ways to save m

See Also

`