Skip to content

Commit a2028d5

Browse files
committed
docs(readme): add document toolset to tool list and usage section
1 parent 5faf98b commit a2028d5

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.ja.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ docker pull ghcr.io/nulab/backlog-mcp-server:latest
109109
| `wiki` | Wikiページを管理するためのツール |
110110
| `git` | Gitリポジトリとプルリクエストを管理するためのツール |
111111
| `notifications` | ユーザー通知を管理するためのツール |
112+
| `document` | ドキュメントおよびドキュメントツリーを参照するためのツール |
112113

113114
### ツールセットの指定
114115

@@ -154,7 +155,6 @@ CLI経由での有効化:
154155

155156
以下のような Backlog 機能に対応するツールを提供しています:
156157

157-
[利用可能なツール]()
158158
[Available Tools セクションへ](https://github.com/nulab/backlog-mcp-server?tab=readme-ov-file#available-tools)
159159

160160
## 使用例

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ The following toolsets are available (enabled by default when `"all"` is used):
109109
| `wiki` | Tools for managing wiki pages |
110110
| `git` | Tools for managing Git repositories and pull requests |
111111
| `notifications` | Tools for managing user notifications |
112+
| `document` | Tools for viewing documents and document trees |
112113

113114
### Specifying Toolsets
114115

@@ -211,6 +212,12 @@ Tools for managing user notifications.
211212
- `reset_unread_notification_count`: Resets unread notification count.
212213
- `mark_notification_as_read`: Marks a notification as read.
213214

215+
### Toolset: `document`
216+
Tools for managing documents and document trees in Backlog projects.
217+
- `get_document_tree`: Returns the hierarchical tree of documents for a project, including folders and ne
218+
- `get_documents`: Returns a flat list of documents in a project or folder.
219+
- `get_document`: Returns detailed information about a specific document, including metadata, content, an
220+
214221
## Usage Examples
215222

216223
Once the MCP server is configured in AI agents, you can use the tools directly in your conversations. Here are some examples:

0 commit comments

Comments
 (0)