@softspark/confluence-mcp 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +59 -0
- package/README.md +166 -0
- package/dist/cli.js +101 -0
- package/dist/index.d.ts +568 -0
- package/dist/index.js +88 -0
- package/package.json +66 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
jira-mcp
|
|
2
|
+
Copyright 2024-2026 Lukasz Krzemien (biuro@softspark.eu)
|
|
3
|
+
|
|
4
|
+
This product includes software developed by SoftSpark.
|
|
5
|
+
Source: https://github.com/softspark/jira-mcp
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License.
|
|
9
|
+
You may obtain a copy of the License at
|
|
10
|
+
|
|
11
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
See the License for the specific language governing permissions and
|
|
17
|
+
limitations under the License.
|
|
18
|
+
|
|
19
|
+
If you redistribute this software or a derivative of it, Section 4(d) of the
|
|
20
|
+
License requires you to carry the contents of this NOTICE file with it.
|
|
21
|
+
|
|
22
|
+
This NOTICE covers jira-mcp only. Third-party dependencies, including code
|
|
23
|
+
bundled into dist/, retain their own copyright notices and licenses. Consult
|
|
24
|
+
package-lock.json for exact dependency versions and each dependency's LICENSE
|
|
25
|
+
and NOTICE files for its terms; npm ls --all lists the installed dependencies.
|
|
26
|
+
|
|
27
|
+
--------------------------------------------------------------------------------
|
|
28
|
+
|
|
29
|
+
PRIOR LICENSE
|
|
30
|
+
|
|
31
|
+
Releases up to and including v1.6.0 were distributed under the MIT License.
|
|
32
|
+
Those releases remain available under MIT; this change applies going forward and
|
|
33
|
+
does not revoke any permission already granted.
|
|
34
|
+
|
|
35
|
+
All contributions to this project were made by the copyright holder named above,
|
|
36
|
+
so no third-party permission was required for the change. The MIT notice is kept
|
|
37
|
+
below for the releases it still governs.
|
|
38
|
+
|
|
39
|
+
MIT License
|
|
40
|
+
|
|
41
|
+
Copyright (c) 2024-2026 Lukasz Krzemien (biuro@softspark.eu)
|
|
42
|
+
|
|
43
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
44
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
45
|
+
in the Software without restriction, including without limitation the rights
|
|
46
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
47
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
48
|
+
furnished to do so, subject to the following conditions:
|
|
49
|
+
|
|
50
|
+
The above copyright notice and this permission notice shall be included in all
|
|
51
|
+
copies or substantial portions of the Software.
|
|
52
|
+
|
|
53
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
54
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
55
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
56
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
57
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
58
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
59
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# confluence-mcp
|
|
2
|
+
|
|
3
|
+
> MCP server for Confluence Cloud -- pages, blog posts, comments, labels, attachments, restrictions and whiteboards via the Model Context Protocol.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@softspark/confluence-mcp)
|
|
6
|
+
[](../../CHANGELOG.md)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
|
|
9
|
+
Part of the [SoftSpark Atlassian MCP workspace](https://github.com/softspark/jira-mcp), alongside [`@softspark/jira-mcp`](../jira-mcp).
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
It reads the same `~/.softspark/jira-mcp/config.json` and the same `credentials.json` as `@softspark/jira-mcp`: one Atlassian site serves both products from the same host, so the API token you already have works for both.
|
|
14
|
+
|
|
15
|
+
The two servers stay separate on purpose. Merging them would put near-homonyms (`search_tasks` next to `search_pages`, `get_task_details` next to `get_page`) in one tool list, which makes tool selection worse. Register whichever you need, or both.
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @softspark/confluence-mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Setup
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
jira-mcp config set-credentials # once, shared by both servers
|
|
27
|
+
confluence-mcp space add DOCS https://your-site.atlassian.net
|
|
28
|
+
confluence-mcp space set-language DOCS pl # optional, inherits default_language
|
|
29
|
+
confluence-mcp space set-format DOCS storage # if the space already has macros
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This adds a `spaces` section next to `projects` in the same config.json:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"projects": { "KAN": { "url": "https://your-site.atlassian.net" } },
|
|
37
|
+
"default_project": "KAN",
|
|
38
|
+
"spaces": {
|
|
39
|
+
"DOCS": { "url": "https://your-site.atlassian.net", "language": "pl", "format": "storage" }
|
|
40
|
+
},
|
|
41
|
+
"default_space": "DOCS"
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Register it alongside the Jira server:
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"mcpServers": {
|
|
50
|
+
"jira": { "command": "jira-mcp" },
|
|
51
|
+
"confluence": { "command": "confluence-mcp" }
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## CLI commands
|
|
57
|
+
|
|
58
|
+
| Command | Description |
|
|
59
|
+
|---------|-------------|
|
|
60
|
+
| `confluence-mcp` | Start the Confluence MCP server (default) |
|
|
61
|
+
| `confluence-mcp serve` | Start the MCP server (explicit) |
|
|
62
|
+
| `confluence-mcp space add <key> <url>` | Add a Confluence space mapping |
|
|
63
|
+
| `confluence-mcp space remove <key>` | Remove a space mapping |
|
|
64
|
+
| `confluence-mcp space list` | List configured spaces |
|
|
65
|
+
| `confluence-mcp space set-default <key>` | Set the space used when `space_key` is omitted |
|
|
66
|
+
| `confluence-mcp space set-language <key> <lang>` | Set the content language for a space |
|
|
67
|
+
| `confluence-mcp space set-format <key> <format>` | Set the body format for a space (`markdown` or `storage`) |
|
|
68
|
+
|
|
69
|
+
## Confluence tools
|
|
70
|
+
|
|
71
|
+
`space_key` is optional on every tool: it falls back to `default_space`, then to the only configured space. It becomes required only when several spaces are configured without a default, where guessing would risk writing into the wrong space.
|
|
72
|
+
|
|
73
|
+
| Tool | Description | Key Parameters |
|
|
74
|
+
|------|-------------|----------------|
|
|
75
|
+
| `list_spaces` | List site spaces plus the locally configured keys | `space_key?`, `limit?` |
|
|
76
|
+
| `get_space_language` | Get the content language and body format for a space | `space_key?` |
|
|
77
|
+
| `search_pages` | Search by plain text or raw CQL, scoped to one space by default | `text?`, `cql?`, `space_key?`, `all_spaces?`, `limit?` |
|
|
78
|
+
| `get_page` | Read a page; body in the space format, or override with `body_format` | `page_id`, `body_format?`, `space_key?` |
|
|
79
|
+
| `list_space_pages` | List the pages in a space | `space_key?`, `limit?` |
|
|
80
|
+
| `get_page_children` | List direct child pages, for walking the tree | `page_id`, `space_key?`, `limit?` |
|
|
81
|
+
| `create_page` | Create a page from markdown or storage XHTML | `title`, `content?`, `storage?`, `parent_id?`, `draft?` |
|
|
82
|
+
| `update_page` | Update title, body or parent; an untouched body is never rewritten | `page_id`, `title?`, `content?`, `storage?`, `parent_id?`, `allow_markup_loss?` |
|
|
83
|
+
| `move_page` | Re-parent a page, across spaces with `cross_space` | `page_id`, `parent_id`, `position?`, `cross_space?` |
|
|
84
|
+
| `delete_page` | Move a page to the trash | `page_id`, `user_approved`, `space_key?` |
|
|
85
|
+
| `get_page_comments` | Read footer comments as markdown | `page_id`, `space_key?`, `limit?` |
|
|
86
|
+
| `add_page_comment` | Add a markdown footer comment or reply | `page_id`, `comment`, `parent_comment_id?`, `user_approved` |
|
|
87
|
+
| `delete_page_comment` | Delete a footer comment | `comment_id`, `user_approved`, `space_key?` |
|
|
88
|
+
| `get_page_inline_comments` | Read anchored review comments with resolution status | `page_id`, `space_key?`, `limit?` |
|
|
89
|
+
| `add_page_inline_comment` | Anchor a comment to a passage, or reply to a thread | `page_id`, `comment`, `text_selection?`, `match_index?`, `parent_comment_id?`, `user_approved` |
|
|
90
|
+
| `list_blog_posts` | List blog posts in a space | `space_key?`, `limit?` |
|
|
91
|
+
| `get_blog_post` | Read a blog post as markdown | `blog_post_id`, `space_key?` |
|
|
92
|
+
| `create_blog_post` | Create a blog post from markdown | `title`, `content`, `draft?`, `space_key?` |
|
|
93
|
+
| `update_blog_post` | Update a blog post title, body or both | `blog_post_id`, `title?`, `content?`, `version_message?` |
|
|
94
|
+
| `delete_blog_post` | Move a blog post to the trash | `blog_post_id`, `user_approved`, `space_key?` |
|
|
95
|
+
| `get_page_restrictions` | Read who may view and edit a page | `page_id`, `space_key?` |
|
|
96
|
+
| `set_page_restrictions` | Replace view/edit restrictions (replaces, does not merge) | `page_id`, `read_account_ids?`, `read_group_ids?`, `update_account_ids?`, `update_group_ids?`, `user_approved` |
|
|
97
|
+
| `get_whiteboard` | Read whiteboard metadata (content is not exposed by the API) | `whiteboard_id`, `space_key?` |
|
|
98
|
+
| `create_whiteboard` | Create an empty whiteboard | `title?`, `parent_id?`, `space_key?` |
|
|
99
|
+
| `delete_whiteboard` | Move a whiteboard to the trash | `whiteboard_id`, `user_approved`, `space_key?` |
|
|
100
|
+
| `get_page_labels` | Read the labels on a page | `page_id`, `space_key?` |
|
|
101
|
+
| `add_page_labels` | Add labels, keeping existing ones | `page_id`, `labels`, `space_key?` |
|
|
102
|
+
| `remove_page_label` | Remove one label | `page_id`, `label`, `space_key?` |
|
|
103
|
+
| `list_attachments` | List attachment metadata and download URLs | `page_id`, `space_key?`, `limit?` |
|
|
104
|
+
| `upload_attachment` | Upload a local file (max 25 MB); a repeat name adds a version | `page_id`, `file_path`, `filename?`, `media_type?`, `comment?` |
|
|
105
|
+
|
|
106
|
+
## Notes
|
|
107
|
+
|
|
108
|
+
- **Two body formats, set per space.** Markdown goes through the same ADF layer Jira uses; storage is Confluence's own XHTML and is the only representation that keeps macros and page links. See [Body format](#body-format-markdown-or-storage) — read it before pointing an assistant at a space you did not create with this tool.
|
|
109
|
+
- **Two API versions on purpose.** CRUD runs on Confluence Cloud v2. CQL search, label writes, restrictions, multipart upload and cross-space moves run on v1, because v2 does not expose them.
|
|
110
|
+
- **Version conflicts are real.** `update_page` reads the page, then writes `version + 1`. If someone saves in between, the call fails with `VERSION_CONFLICT` instead of overwriting their edit. Re-read the page and reapply the change.
|
|
111
|
+
- **Inline comments are checked before they are anchored.** `add_page_inline_comment` counts the passage in the page body and refuses text that is not there, rather than attaching the comment to the wrong place.
|
|
112
|
+
- **Restrictions replace, they do not merge.** `set_page_restrictions` with no ids clears restrictions entirely and returns the page to space permissions, which can expose a deliberately private page. It needs `user_approved` for that reason.
|
|
113
|
+
- **Whiteboard content is not reachable.** The API exposes the container only; `create_whiteboard` makes an empty board that a person has to fill in the browser.
|
|
114
|
+
- **Not covered:** Confluence databases, custom content types, and space administration.
|
|
115
|
+
|
|
116
|
+
## Body format: markdown or storage
|
|
117
|
+
|
|
118
|
+
Confluence stores pages as **storage format**: XHTML carrying macros (`info`/`note`/`warning` panels, tables of contents, code blocks with a language), links to other pages, and attachment and image references. Markdown has no way to express any of that. Converting such a page to markdown and back keeps the visible prose and silently deletes the rest.
|
|
119
|
+
|
|
120
|
+
Set the format per space, once:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
confluence-mcp space set-format DevOps storage # pages are Confluence XHTML
|
|
124
|
+
confluence-mcp space set-format DOCS markdown # pages are markdown (default)
|
|
125
|
+
confluence-mcp space list # shows the format column
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
In config.json, per space or as a global default:
|
|
129
|
+
|
|
130
|
+
```json
|
|
131
|
+
{
|
|
132
|
+
"spaces": {
|
|
133
|
+
"DevOps": { "url": "https://your-site.atlassian.net", "format": "storage" },
|
|
134
|
+
"DOCS": { "url": "https://your-site.atlassian.net" }
|
|
135
|
+
},
|
|
136
|
+
"default_format": "markdown"
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### What each setting does
|
|
141
|
+
|
|
142
|
+
| | `markdown` (default) | `storage` |
|
|
143
|
+
|---|---|---|
|
|
144
|
+
| `get_page` returns | markdown | Confluence XHTML |
|
|
145
|
+
| `create_page` / `update_page` take | `content` | `storage` |
|
|
146
|
+
| the other kind of body | `storage` is accepted too — it never loses anything | `content` is **refused** with `MARKUP_LOSS_REFUSED` |
|
|
147
|
+
| pages that already contain macros | markdown write refused per page | n/a, the whole space is storage |
|
|
148
|
+
|
|
149
|
+
`get_space_language` reports both the language and the format, so an assistant can ask once and then write correctly. `get_page` also returns `has_storage_markup`, which flags a macro-bearing page inside a markdown space.
|
|
150
|
+
|
|
151
|
+
### Rules that hold in both modes
|
|
152
|
+
|
|
153
|
+
- **An untouched body is never rewritten.** `update_page` that changes only the title or the parent writes the existing body back byte for byte.
|
|
154
|
+
- **An explicit read wins.** `get_page` with `body_format` overrides the space setting for that one call; the setting picks the default, it does not forbid looking.
|
|
155
|
+
- **The escape hatch is explicit.** `allow_markup_loss: true` lets markdown through in a storage space, or over a macro-bearing page. Use it only after the user agrees the macros and links may go.
|
|
156
|
+
|
|
157
|
+
If your space is managed as code (HTML files pushed via the REST API, as `sync.py` does), it is a `storage` space. Set it before pointing an assistant at it.
|
|
158
|
+
|
|
159
|
+
## Documentation
|
|
160
|
+
|
|
161
|
+
- [Confluence reference](../../kb/reference/confluence.md) -- architecture, API split, ADF and storage formats, restrictions, version conflicts.
|
|
162
|
+
- [Changelog](../../CHANGELOG.md) -- shared with `@softspark/jira-mcp`; both packages are released together under one version.
|
|
163
|
+
|
|
164
|
+
## License
|
|
165
|
+
|
|
166
|
+
Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
|