1.0.4 • Published 3 months ago
@yh1715/backlog-mcp v1.0.4
Backlog MCP Server
- BacklogのAPIを使用してMCPサーバーを実装したプロジェクトです。
- プロジェクト固定かつ、読み取り操作のみを行います。
利用方法(CursorまたはClaude Desktopとの連携)
以下の設定を行ってください:
mcp.jsonを作成します
{ "mcpServers": { "backlog": { "command": "npx", "args": ["@yh1715/backlog-mcp"], "env": { "BACKLOG_API_KEY": "your_api_key_here", "BACKLOG_SPACE_ID": "your_space_id_here", "BACKLOG_PROJECT_ID": "your_project_id_here" } } } }
OSやスコープに合わせてmcp.jsonを配置します
- プロジェクト固有の設定の場合:
- プロジェクトディレクトリに
.cursor/mcp.json
を配置
- プロジェクトディレクトリに
- グローバル設定の場合:
- Windows:
%USERPROFILE%\.cursor\mcp.json
に配置 - macOS:
~/.cursor/mcp.json
に配置
- Windows:
- 設定後、Cursorを再起動すると、Agentが自動的にBacklogツールを使用できるようになります。
利用可能なツール
課題関連
backlog.issues.list
: 課題一覧の取得backlog.issues.get
: 課題の詳細取得backlog.issues.comments
: 課題コメントの取得backlog.issues.attachment
: 課題の添付ファイルのダウンロード
Wiki関連
backlog.wikis.list
: Wikiページ一覧の取得backlog.wikis.get
: Wikiページの詳細取得backlog.wikis.attachments
: Wiki添付ファイル一覧の取得backlog.wikis.attachment
: Wiki添付ファイルのダウンロード
開発
このセクションは、このプロジェクトの開発を行う開発者向けの情報です。
プロジェクトを利用するだけの場合、このセクションの手順は不要です。
セットアップ
- 依存関係のインストール:
bun install
- 環境変数の設定:
.env.example
をコピーして.env
を作成し、必要な情報を設定してください:
BACKLOG_API_KEY=your_api_key_here
BACKLOG_SPACE_ID=your_space_id_here
BACKLOG_PROJECT_ID=your_project_id_here
実行方法
bun run src/index.ts
このサーバーはMCP(Model Context Protocol)に準拠しており、stdioトランスポートを使用して通信します。