atlassian-readonly
Atlassian Read-only MCP
一个为 AI 助手提供 Jira 和 Confluence 只读访问权限的小型 MCP 服务器。只读访问通过两层机制强制实现:
Atlassian 令牌仅包含只读作用域。
服务器仅实现允许列表中的 GET 请求。
它提供四个工具:
读取 Jira 问题(issue)
使用 JQL 搜索 Jira
读取 Confluence 页面
使用 CQL 搜索 Confluence
没有通用的 HTTP 工具,也没有实现 POST、PUT、PATCH 或 DELETE。即使意外提供了更广的凭据,MCP 客户端仍然没有任何工具可以更改 Jira 或 Confluence 的内容。响应大小受到限制,可能涉密的字段会被脱敏,Confluence 存储 HTML 会转换为 Markdown,并且可选的 JMESPath 投影可以精简返回的数据。
要求
Node.js 20 或更高版本
有权访问已配置的 Atlassian Cloud 租户
为 Jira 和 Confluence 分别创建带作用域的 API 令牌
一个 MCP 客户端,例如 VS Code 中的 GitHub Copilot
Related MCP server: MCP Atlassian Server
安装
git clone https://github.com/AlexSchaap-TMMC/atlassian-readonly-mcp.git C:\Tools\atlassian-readonly
Set-Location C:\Tools\atlassian-readonly
npm install
npm test创建 API 令牌
打开 Atlassian API 令牌页面,创建两个令牌。
Jira 令牌
read:jira-work该经典作用域单独通过验证,可用于问题检索和 JQL 搜索。仅包含等价细粒度作用域的 Jira 令牌曾被 Atlassian 拒绝,返回 401 Unauthorized; scope does not match。
Confluence 令牌
read:page:confluence
read:content-details:confluence
search:confluence这些细粒度作用域已通过 CQL 搜索和页面全文检索的验证。
令牌创建完成后,作用域便固定不变。Jira 和 Confluence 需要分别使用单独的令牌。请从一次性令牌创建对话框中复制令牌,不要将其放入源文件、MCP 配置、shell 历史、issue 或聊天中。
不要添加写入或管理作用域。受到限制的令牌能确保 Atlassian 独立于 MCP 实现之外直接拒绝写入操作。
存储凭据
在仓库目录下执行:
npm run configure -- jira
npm run configure -- confluence隐藏的提示会将每个令牌分别保存到 Windows 凭据管理器、macOS Keychain 或 Linux Secret Service 中。Atlassian 账户邮箱应放在 MCP 环境中,而不是凭据存储中。
在 VS Code 中配置 GitHub Copilot
在命令面板中运行 MCP: Open User Configuration:
{
"servers": {
"atlassian-readonly": {
"type": "stdio",
"command": "node",
"args": ["C:\\Tools\\atlassian-readonly\\src\\server.mjs"],
"env": {
"ATLASSIAN_USER_EMAIL": "your.atlassian.email@example.com",
"NODE_OPTIONS": "--use-system-ca"
}
}
}
}重新加载 VS Code、打开 Copilot Chat、选择 Configure Tools,然后启用这四个 Atlassian 工具。
示例提示:
Read HEC-123 and summarize its acceptance criteria.
Search Jira for open bugs assigned to me.
Search Confluence for pages about Kafka retry handling.配置 GitHub Copilot CLI
copilot mcp add atlassian-readonly `
--env ATLASSIAN_USER_EMAIL="your.atlassian.email@example.com" `
--env NODE_OPTIONS="--use-system-ca" `
-- node C:\Tools\atlassian-readonly\src\server.mjs添加或更改服务器之后,请重启 Copilot CLI。
故障排查
认证
请检查以下各项:
邮箱与创建令牌的 Atlassian 账户一致。
存入了正确的环境令牌。
令牌仍然有效,且账户有权访问所请求的内容。
Jira 使用
read:jira-work,而不只是细粒度的单个 Jira 作用域。Confluence 已包含上文列出的全部三个作用域。
替换令牌后重启了 MCP 宿主。
带作用域的令牌必须使用 Atlassian 的产品网关:
https://api.atlassian.com/ex/jira/{cloudId}
https://api.atlassian.com/ex/confluence/{cloudId}本服务器使用 src/atlassian.mjs 中固定的租户 Cloud ID。
企业证书
TLS 检查产品(如 Zscaler)会使用企业证书颁发机构对 HTTPS 流量重新签名。Windows 可能会信任该颁发机构,但 Node.js 仍在使用自带的 CA 列表。在受支持的 Node.js 版本中,请把以下变量保留在 MCP 环境中:
NODE_OPTIONS=--use-system-ca如有必要,请将未过期的企业 CA 导出为 Base-PEM 格式,并设置 NODE_EXTRA_CA_CERTS 为其绝对路径。绝不 TLS 验证。
WSL 拥有独立的 Linux 信任库。请将从 Windows 导出的适用企业根证书和中间证书保存为 .crt 扩展名,复制到 /usr/local/share/ca-certificates/,然后运行:
sudo update-ca-certificates在重新尝试 curl、Docker、Node.js 或其他 HTTPS 客户端之前,请先重启 WSL。
WSL 与 headless 系统
如果没有桌面 keystore,请使用受限的令牌文件:
mkdir -p ~/.config
install -m 600 /dev/null ~/.config/atlassian-jira-token
install -m 600 /dev/null ~/.config/atlassian-confluence-token
read -rsp "Jira API token: " token; echo
printf '%s' "$token" > ~/.config/atlassian-jira-token
read -rsp "Confluence API token: " token; echo
printf '%s' "$token" > ~/.config/atlassian-confluence-token
unset token在 MCP 环境中配置这些变量:
ATLASSIAN_USER_EMAIL
ATLASSIAN_JIRA_TOKEN_FILE
ATLASSIAN_CONFLUENCE_TOKEN_FILEATLASSIAN_JIRA_API_TOKEN 和 ATLASSIAN_CONFLUENCE_API_TOKEN 适用于进程范围的 CI 使用,但不应保存在桌面配置中。
轮换或删除凭据
替换已存储的令牌:
npm run configure -- jira
npm run configure -- confluence删除已存储的令牌:
npm run configure -- jira delete
npm run configure -- confluence delete本地删除不会吊销令牌。请另行在 Atlassian 的令牌管理页面吊销令牌。
安全边界
本项目采用纵深防御机制:
令牌强制: 文档中记录的令牌只包含 Atlassian 只读作用域,因此 Atlassian 不会授权写入操作。 实现强制: 只有四个边界窄化的只读工具。它们的 URL 和 HTTP 方法是固定的;调用方无法选择其他主机、端点或方法。 响应控制: 响应大小受限制,疑似敏感的字段会被脱敏,投影能够极端化返回的数据。
令牌仍然继承创建者的可见范围:MCP 只能读取该账户此前可访问的内容。如果提供权限更大,则令牌层被削弱,但不会为 MCP 增加写入操作。
许可证
Available Tools
4 toolsconfluence_get_pageA
Read a Confluence page by ID and convert storage HTML to Markdown. This server has no write operations.
| Name | Required | Description | Default |
|---|---|---|---|
| page_id | Yes | ||
| projection | No | Optional JMESPath projection to reduce returned fields. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the behavioral burden. It discloses the conversion behavior (storage HTML to Markdown) and states the server has no write operations, which is helpful. However, it does not mention error handling, response format, or any limits, leaving gaps for an agent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no filler. The main purpose is front-loaded, and the read-only clarification is concise and useful. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read tool with only two parameters and no output schema, the description covers the core purpose and behavioral nuance. It does not explain return structure or error scenarios, but these are less critical given the tool's simplicity. Overall, it is sufficiently complete for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 50%: projection has a description, but page_id does not. The description does not compensate for the missing page_id semantics beyond reiterating 'by ID'. It adds nothing about projection beyond the schema, so minimal value is provided for parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb ('Read') and a specific resource ('Confluence page by ID'), plus a distinctive detail (conversion to Markdown). This distinguishes it from sibling tools like confluence_search and jira_get_issue without needing to inspect the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly implies usage when a page ID is known, but it does not explicitly contrast with confluence_search or state when NOT to use this tool. The read-only note provides general context, but no alternative routing guidance is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
confluence_searchA
Search Confluence with CQL. Results are bounded; this server has no write operations.
| Name | Required | Description | Default |
|---|---|---|---|
| cql | Yes | ||
| limit | No | ||
| projection | No | Optional JMESPath projection to reduce returned fields. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the behavioral burden. It adds useful context by stating 'Results are bounded' and 'this server has no write operations,' which helps the agent understand output scaling and that the tool performs no mutations. It does not detail result shape or error behavior, but for a simple search tool this is reasonably transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core purpose, and contains no filler. The safety note about no write operations is brief and earns its place given the lack of annotations.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a three-parameter search tool, the description plus schema covers the basic calling contract, but there is no output schema and the description does not mention what the search returns, pagination behavior, or any example CQL. 'Results are bounded' hints at limits but leaves practical expectations underspecified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33% because only projection has a description. The main description mentions CQL, which gives some meaning to the cql parameter, but it does not explain how to construct CQL, what limit controls beyond its schema constraints, or how projection interacts with results. The description does not sufficiently compensate for the low schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action and resource: 'Search Confluence with CQL.' This clearly separates it from sibling tools like jira_search_issues and confluence_get_page, since the resource (Confluence) and operation (search) are both explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this tool should be used for searching Confluence, but it does not explicitly say when to choose it over siblings such as confluence_get_page or jira_search_issues. There is no when-not-to-use guidance or mention of alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
jira_get_issueA
Read one Jira issue. This server has no write operations.
| Name | Required | Description | Default |
|---|---|---|---|
| issue_key | Yes | ||
| projection | No | Optional JMESPath projection to reduce returned fields. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. It does mention the read-only nature and that the server has no write operations, which is useful context. However, it does not describe error behavior, response format, or what happens when the issue does not exist.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences, both earning their place. It front-loads the core action and adds the server-wide write constraint without any redundant phrasing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read tool, the inputs and general action are covered, but the absence of an output schema means the return value is only implied. The description does not clarify what fields are returned or how to interpret the response, leaving a moderate gap for the agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides a pattern for issue_key and a description for projection, but the tool description itself adds no parameter-level explanation. With schema coverage at 50%, the description does not compensate for the undocumented issue_key semantics, though the parameter name is fairly self-explanatory.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('read') and resource ('one Jira issue'), making the tool's purpose unmistakable. It is clearly differentiated from sibling search and Confluence tools by focusing on a single issue retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when a specific issue key is available, but it does not explicitly mention jira_search_issues as the alternative for query-based retrieval. There is no warning against using it for searches or a clear when-not-to-use statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
jira_search_issuesB
Search Jira with JQL. Results and fields are bounded; this server has no write operations.
| Name | Required | Description | Default |
|---|---|---|---|
| jql | Yes | ||
| limit | No | ||
| projection | No | Optional JMESPath projection to reduce returned fields. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. It adds two useful traits: 'Results and fields are bounded' and 'this server has no write operations', which are not present in the schema. However, it omits details like pagination, ordering, rate limits, or error behavior, so transparency is partial.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, tight sentence that front-loads the core action and immediately adds a scope limitation. No filler words or redundant repetition of the tool name. Every phrase contributes meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given three parameters, no output schema, and no annotations, the description is not sufficient. It does not describe what a search result looks like, how to construct a valid JQL query, or the effect of 'limit' and 'projection'. The bounded/no-write note is useful but only addresses safety, not invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only 33% of the parameters have schema descriptions (projection). The description clarifies that 'jql' is the Jira Query Language string, but it does not explain the 'limit' parameter or add syntax/format details. Since schema coverage is low, the description should compensate more but does not for two of the three parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb ('Search') and resource ('Jira'), and correctly implies searching issues via the tool name and JQL mention. It distinguishes from jira_get_issue (which fetches a single issue) and confluence_search (different product), though it does not explicitly say 'issues' or contrast these siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use this tool versus alternatives. The description does not mention jira_get_issue, confluence_search, or any condition that would select one over the other. The only usage hint is 'Search Jira with JQL', which is implied functionality rather than a directive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
4 tool updates
v0.1.0- First observed
confluence_get_page - First observed
confluence_search - First observed
jira_get_issue - First observed
jira_search_issues
TDQS
Scored across 4 tools
Each tool has a clearly distinct purpose: get versus search for both Jira and Confluence. There is no overlap or ambiguity between any pair, enabling precise tool selection.
All tool names follow a consistent product_action pattern with snake_case (e.g., jira_get_issue, confluence_search). The naming is uniform and predictable.
With 4 tools covering two products (Jira and Confluence) each having a get and search operation, the count is well-scoped for a read-only server. No tool feels redundant or missing.
The read-only surface provides essential get and search for both products. Minor gaps exist such as bulk fetch or additional metadata endpoints, but core querying needs are well covered.
Maintenance
Related MCP Connectors
Connect to Atlassian Jira, Confluence, Loom, and more to search, create, and manage your work.
Safe, read-only Postgres and MySQL access for AI agents. Audit log + column-level controls.
- OpenOakOAuthorg.openoak
Secure AI access to OpenOak tasks, notes, and Kanban boards.
Connect AI to store orders, products and inventory with scoped access and human approvals.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to interact with Atlassian products (Confluence and Jira) through natural language, supporting both Cloud and Server/Data Center deployments. Allows searching, creating, and managing content across Jira issues and Confluence pages with flexible authentication options.Apache 2.0
- AlicenseAqualityDmaintenanceIntegrates with Atlassian Cloud products (Confluence and Jira) to enable AI assistants to search, read, create, and manage pages, issues, comments, attachments, and export content through natural language interactions.404,608 npmMIT
- FlicenseNot gradedqualityCmaintenanceEnables AI assistants to search, retrieve, and manage Confluence pages, and generate weekly status drafts from Jira activity.1-
- AlicenseNot gradedqualityBmaintenanceEnables AI assistants to deeply introspect Jira Data Center configurations — including workflows, schemes, automation, and Assets — through 76 read-only tools, without any modification capability.5MIT