Add Atlassian Rovo MCP connector docs#705
Conversation
Pranesh-Raghu
requested review from
amitash1912,
ravibits and
saif-at-scalekit
as code owners
✅ Deploy Preview for scalekit-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughAdds the Atlassian Rovo MCP connector: a typed tools catalog, updated capabilities, setup and common-workflows MDX sections for Scalekit-managed OAuth, connector docs with quickstart and embedded tool list, and component re-exports to register the new sections. ChangesAtlassian MCP Connector
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/data/agent-connectors/atlassianmcp.ts`:
- Around line 1321-1325: Update the parameter description for the searchString
field used by getVisibleJiraProjects (symbol:
getvisiblejiraprojects.searchString) so it accurately describes project
searching instead of user lookup; change the text from referencing "Jira users"
to something like "Text to search for when looking up Jira projects" (or similar
wording that matches the getVisibleJiraProjects endpoint behavior) to avoid
contradiction with the tool's actual function.
- Around line 1431-1435: The tool parameter description for
searchjiraissuesusingjql.fields is wrong (it describes updating fields); update
the description in the tool definition for the 'fields' parameter so it
documents response field selection instead — e.g., state that it controls which
issue fields are returned (a comma-separated list or array of JIRA field keys
like "summary,priority,assignee") and clarify format and default behavior;
locate the 'fields' entry in the searchjiraissuesusingjql tool config and
replace the current update-oriented description with a response-selection
description.
- Around line 985-989: The description for the 'fields' parameter in the
getjiraissue tool is incorrect (it currently describes an update JSON); update
the description in the schema where name: 'fields' is defined for getjiraissue
so it accurately reflects a read operation (e.g., "Fields to return as an array
of field keys or names, e.g. ['summary','priority']" or "Comma-separated list of
fields to fetch") instead of describing an update payload; locate the
getjiraissue parameter block in atlassianmcp.ts and replace the misleading text
accordingly.
- Around line 128-137: The field descriptions for the Compass connector are
wrong — update the schema entries for the createcompasscomponent tool (the
object with name: 'description' and name: 'labels' in
src/data/agent-connectors/atlassianmcp.ts) so they describe a Compass
component’s description and its component labels (not “Jira issue” or “space
labels”); locate the createcompasscomponent parameter definitions and replace
the mismatched strings with accurate wording like “The full description of the
Compass component.” and “List of labels/tags to assign to the Compass
component.” to match the tool’s behavior.
- Around line 386-390: The description for the parameter field 'type' on the
createissuelink tool is wrong (it currently says "Space type filter"); update
the description on the createissuelink object's 'type' property to reflect Jira
issue link semantics (e.g., "Jira issue link type (e.g., 'relates', 'blocks',
'duplicates')" or similar), so the createissuelink.type description accurately
documents that it expects a Jira link type rather than a space filter.
In `@src/data/agent-connectors/capabilities.json`:
- Line 4: Update the Jira capability string in capabilities.json by removing the
unsupported "watchers" term: locate the entry containing "**Manage Jira issues**
— create, edit, transition, comment on, and link issues; add worklogs and
watchers" and edit it to omit "and watchers" (e.g., "...; add worklogs" or
similar), so the capability description accurately reflects available Atlassian
operations.
In `@src/data/agent-connectors/catalog.ts`:
- Line 148: The categories array currently uses the hyphenated slug
'developer-tools' which doesn't match the project's underscore convention;
update the categories property (the array named categories in this connector
object) to replace 'developer-tools' with 'developer_tools' so it aligns with
the catalog taxonomy and will be picked up by underscore-based filters/grouping.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 0f791237-a6ad-43fd-b7b4-0915563eb5e5
⛔ Files ignored due to path filters (5)
src/assets/docs/agent-connectors/atlassianmcp/add-credentials.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/atlassianmcp/add-domain-modal.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/atlassianmcp/add-domain-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/atlassianmcp/add-redirect-uri.pngis excluded by!**/*.pngsrc/assets/docs/agent-connectors/atlassianmcp/copy-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (6)
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/components/templates/agent-connectors/index.tssrc/content/docs/agentkit/connectors/atlassianmcp.mdxsrc/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/catalog.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (21)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Prefer interface for defining object shapes in TypeScript
Use camelCase for variable names
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,py,go,java,mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java,mdx,md}: Use the exact SDK variable names: Node.js (scalekit), Python (scalekit_client), Go (scalekitClient), Java (scalekitClient)
Never hard-code secrets or API keys in code examples; use environment variables
Include security comments that state the threat, why the pattern is required, and what can go wrong if omitted
Files:
src/data/agent-connectors/catalog.tssrc/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdxsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,py,go,java}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java}: Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments with parameter descriptions, return values, and types
Comments should not duplicate the code; explain what the code does conceptually, not literally
Use better variable names and structure instead of comments to explain poorly written code
Explain unidiomatic or redundant code in comments; clarify why a specific pattern was chosen
Document exceptions and edge cases in code comments
Include links to external references (standards, RFCs, official documentation) in comments where helpful
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,json}
📄 CodeRabbit inference engine (CLAUDE.md)
Use
pnpmfor package management
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,jsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
**/*.{ts,tsx,js,jsx,py,go,java}: Comments should not duplicate the code; comments should add value beyond what's obvious. Use better variable names and structure instead of using comments to explain poorly written code
Don't use comments to excuse unclear code. Comments should dispel confusion, not cause it. Ensure comments clarify rather than obscure purpose
Explain unidiomatic code in comments: comment on code that might seem unnecessary or redundant; explain why you chose a specific pattern
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments including parameter descriptions, return values, types, and descriptions
Document exceptions and edge cases in code comments
Include links to external references in code comments where helpful (standards, RFCs, official documentation)
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments in code
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{md,mdx,astro,ts}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{md,mdx,astro,ts}: Usepnpm pretty-quick --stagedvia pre-commit git hook to auto-format all staged.md,.mdx,.astro,.tsfiles with Prettier
Runpnpm formatto auto-format all.md,.mdx,.astro,.tsfiles before pushing changes
Files:
src/data/agent-connectors/catalog.tssrc/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdxsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
src/data/agent-connectors/**
⚙️ CodeRabbit configuration file
src/data/agent-connectors/**: These are connector tool definition files (TypeScript data objects).
- Do NOT suggest extracting constants, refactoring data structures,
or renaming fields — these match the upstream API schemas.- Do NOT suggest adding parameters that don't exist in the upstream API.
- DO flag: incorrect types, missing required fields per the
AgentConnectorTool schema, and description text that contradicts
what the tool actually does.
Files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.ts
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- Headings that match a real API parameter, method, or field name
(e.g.,contactID,xero_tenant_id,executeTool) should preserve
the original casing. Do NOT flag these as sentence-case violations.- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:f...
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
**/*.{mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{mdx,md}: All code examples must use<Tabs syncKey="tech-stack">format and include Node.js, Python, Go, and Java implementations (90% rule)
Use sentence case for all titles and headings in documentation
Use bold for first mention of important terms, UI elements, and dashboard paths (e.g., Dashboard > Authentication > Session Policy)
Use inline code for technical identifiers: variables, functions, endpoints, scopes, environment variables, file paths, and placeholders
Always include headers in tables; keep cell content concise and readable
Prefer fenced code blocks with language identifiers for all code; never use screenshots of code
Use descriptive link text; never use 'click here' or 'this' as link labels
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns
Use active voice; prefer 'Run the command' over 'The command should be run'
Use second person when giving instructions; address the reader as 'you'
Use present tense for procedures; 'This command installs…' not 'This command will install…'
Avoid hype, slang, and filler words like 'simply', 'just', 'obviously' in documentation
Use consistent terminology throughout; prefer standard names over synonyms
Explain security implications and threats for all security-related content
Use imperative verbs for procedure headings: 'Run a script' not 'Running a script'; 'Configure proxies' not 'Configuring proxies'
Headings must describe outcomes, not categories (good: 'Run a script'; bad: 'Scripts')
Split content into clear sections with descriptive, sentence-style titles that convey meaning without requiring the following paragraph
Keep paragraphs short; isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content
Put the topic words at the beginning of topic sentences to support fast skimming
Put key takeaways and results at the top of documents and sections
Use bullets and tabl...
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
src/components/templates/agent-connectors/_setup-*.mdx
⚙️ CodeRabbit configuration file
src/components/templates/agent-connectors/_setup-*.mdx: These are connector setup templates. Override the global MDX rule:
- Do NOT require all four SDK language tabs. Setup templates show
auth-redirect and credential configuration which may only apply
to Node.js and Python. Require tabs ONLY when the snippet
demonstrates Scalekit client SDK usage (scalekit / scalekit_client).- DO check: missing
osor other standard library imports in
Python snippets, and missingrequire/importin Node.js snippets.
Files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
src/content/docs/**/*.mdx
📄 CodeRabbit inference engine (.cursor/rules/starlight-steps-tabs-structure.mdc)
src/content/docs/**/*.mdx: In MDX documentation files,<Steps>must contain one continuous ordered list. Wrap<Steps>around a normal Markdown ordered list such as1. ## ...
In MDX documentation files, numbered step lines must start at column 0. Do not indent the1. ##,2. ##, etc.
In MDX documentation files, any content that belongs to a step must be indented with 3 spaces: paragraphs, bullets, images,<Tabs>,<TabItem>, and fenced code blocks
In MDX documentation files, prefer plain Markdown inside<Steps>. If the content is mostly<Tabs>or other JSX-heavy blocks, use normal section headings instead of<Steps>
In MDX documentation files, when<Tabs>is used inside a step, keep<Tabs>,<TabItem>,</TabItem>, and</Tabs>consistently nested under that step
In MDX documentation files, if a tabs block is not part of a numbered step, place it outside</Steps>
Files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
src/content/docs/**/*.{mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
src/content/docs/**/*.{mdx,md}: Every documentation page must include frontmatter with at least:title,description, andsidebar.label
Page titles must be ≤60 characters and descriptions must be ≤160 characters
Sidebar labels must be concise (1-3 words) and use sentence case without punctuation
Use<Steps>component with single continuous ordered list; numbered steps start at column 0, continuation content indented with exactly 3 spaces
Use relative links for internal pages; include anchors for sections
Include a table of contents for documents with multiple sections; enabletableOfContents: truein frontmatter
Files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
src/content/docs/agentkit/**/*.{mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
Code examples for agentkit documentation live in the external repo
scalekit-developers/agent-auth-examples; verify documentation snippets match current implementation
Files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
src/content/**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
src/content/**/*.mdx: All documentation must live as MDX files insidesrc/content/
Every documentation page must have frontmatter with title (≤60 characters), description (≤160 characters), sidebar label, order, and tags
Write documentation in second person using 'you' and 'your application', present tense for descriptions, and imperative for step-by-step instructions
Avoid filler phrases like 'simply', 'just', 'easily' in documentation and be direct
Explain security implications when relevant in documentation
Every code block demonstrating an SDK operation must include all four languages (Node.js, Python, Go, Java) using synced tabs with syncKey='tech-stack'
SDK variable names are fixed and must not be renamed: Node.js usesscalekit, Python usesscalekit_client, Go usesscalekitClient, Java usesscalekitClient
Files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
src/content/docs/agentkit/connectors/**/*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Agent connector docs must use the generated workflow via
pnpm run sync-agent-connectorsand setup/usage/custom sections must be added through component templates
Files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
🧠 Learnings (31)
📚 Learning: 2026-05-19T07:25:58.491Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 654
File: src/data/agent-connectors/asana.ts:3-1072
Timestamp: 2026-05-19T07:25:58.491Z
Learning: Files under `src/data/agent-connectors/` (e.g., connector implementations auto-generated from the tool-agent API, such as `asana.ts`) are generated by the sync script and already have tool-name and param-name uniqueness guaranteed by the source system. In code reviews, avoid recommending hand-written/hand-maintained integrity tests specifically for these generated connector files, since correctness is enforced upstream.
Applied to files:
src/data/agent-connectors/catalog.tssrc/data/agent-connectors/atlassianmcp.ts
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (.mdx files), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag links for missing `target="_blank"` or `rel="noopener"` (avoid adding raw HTML anchors just to include those attributes), and keep the approach consistent with existing docs styling.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-03-10T10:38:30.012Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-clickup.mdx:17-17
Timestamp: 2026-03-10T10:38:30.012Z
Learning: In the repository's agent-connectors setup template files (src/components/templates/agent-connectors/_setup-*.mdx), the pattern for redirect URI screenshot images is to use empty alt text (![]()). Do not flag missing alt text for these specific Markdown image syntaxes in the agent connector setup template files. This guidance applies only to files matching this setup-*.mdx naming pattern; other templates should continue to enforce standard alt text practices.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-03-12T16:28:37.168Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-zendesk.mdx:20-20
Timestamp: 2026-03-12T16:28:37.168Z
Learning: In src/components/templates/agent-connectors/_setup-*.mdx files, external links should not be flagged for missing target="_blank" and rel="noopener". Plain Markdown link syntax (e.g., [Scalekit dashboard](https://app.scalekit.com)) is acceptable and intentional in these agent-connector setup templates, following the established pattern across all connector templates in this directory.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-03-12T16:29:08.626Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-onenote.mdx:12-12
Timestamp: 2026-03-12T16:29:08.626Z
Learning: In files matching src/components/templates/agent-connectors/_setup-*.mdx, permit and reflect the branding 'Azure Active Directory' (AAD) as intentional. Do not flag or update these agent-connectors setup templates for references to 'Microsoft Entra ID'. This exception applies only to these setup template files; maintain standard branding elsewhere according to project guidelines.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-06T07:23:46.423Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 658
File: src/components/templates/agent-connectors/_section-before-tool-list-xero-common-patterns.mdx:15-63
Timestamp: 2026-05-06T07:23:46.423Z
Learning: In agentkit agent connectors documentation (files under src/components/templates/agent-connectors and src/content/docs/agentkit/connectors), do not require all four language tabs for SDK code examples. These docs may use only the language tabs relevant to the content (e.g., Node.js and Python). This is an exception to the standard multilingual guideline and should be applied consistently across connector docs.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T16:00:06.233Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/components/templates/agent-connectors/_section-after-setup-gmail-common-workflows.mdx:13-39
Timestamp: 2026-05-07T16:00:06.233Z
Learning: In documentation MDX files under src/components/templates/agent-connectors/ and src/content/docs/agentkit/connectors/, code examples are intentionally simplified. Do not require or flag missing error handling/failure paths (e.g., try/catch, retries, or explicit error returns) in these docs, even if the project’s general guideline expects both success and error paths in code examples.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T16:00:21.950Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/components/templates/agent-connectors/_section-after-setup-google_ads-common-workflows.mdx:10-18
Timestamp: 2026-05-07T16:00:21.950Z
Learning: In AgentKit agent connector documentation code examples located under src/components/templates/agent-connectors/** and src/content/docs/agentkit/connectors/** (MDX files), do not add explicit error handling in the sample code (e.g., no try/catch blocks or rejected-promise branches). These snippets are intentionally “success-path only” to keep the documentation concise, and this is an explicit exception to any general review guideline that requires both success and error paths in every code example.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (MD/MDX), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag external links for missing `target="_blank"` or `rel="noopener"`, and avoid converting Markdown links into raw HTML `<a>` tags just to add those attributes, since that would be inconsistent with the established doc pattern.
Applied to files:
src/components/templates/agent-connectors/_setup-atlassianmcp.mdxsrc/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-01-30T18:18:50.883Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 415
File: src/content/docs/authenticate/fsa/multiapp/manage-apps.mdx:31-49
Timestamp: 2026-01-30T18:18:50.883Z
Learning: In all Scalekit documentation files (MDX), treat the terms 'Applications', 'Single Page Application (SPA)', 'Native Application', and 'Web Application' as proper nouns and preserve their capitalization in headings and body text. Ensure these terms remain capitalized even when used in sentence case or within prose.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-02-04T12:47:16.544Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 412
File: src/content/docs/dev-kit/tools/scalekit-dryrun.mdx:1-23
Timestamp: 2026-02-04T12:47:16.544Z
Learning: In scalekit-inc/developer-docs, the MDX frontmatter field order is required only when the sidebar configuration points to a directory (for auto-generation). If the sidebar.config.ts references a specific file path, the order field is not required. Apply this check to all MDX files under src/content/docs: if a file contributes to an auto-generated sidebar (directory path), ensure order is present; if it’s linked to a concrete file, order can be omitted. Use sidebar.config.ts to determine whether a given MDX file falls under directory-based vs file-specific sidebar references.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-02-25T08:57:12.201Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/quickstart.mdx:2-10
Timestamp: 2026-02-25T08:57:12.201Z
Learning: In Scalekit developer-docs (Astro Starlight), do not auto-suggest adding tableOfContents in frontmatter unless the user explicitly overrides the default behavior. The default enables tableOfContents with minHeadingLevel 2 and maxHeadingLevel 3. Only set tableOfContents when you want to customize heading levels or disable it entirely; otherwise omit it for other docs.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-02-25T13:04:27.491Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:9-17
Timestamp: 2026-02-25T13:04:27.491Z
Learning: Allow page-level CSS overrides in MDX frontmatter (head: style) for readability and engagement, even if it customizes typography beyond defaults. This applies to per-page UX decisions, including heading sizes and style tweaks, but keep overrides purposeful, accessible, and within the repository's design guidelines. Use these overrides sparingly and document the rationale for maintainability.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-03-05T11:29:08.125Z
Learnt from: AkshayParihar33
Repo: scalekit-inc/developer-docs PR: 463
File: src/content/docs/agent-auth/providers.mdx:35-73
Timestamp: 2026-03-05T11:29:08.125Z
Learning: In src/content/docs/agent-auth/providers.mdx, the Card components intentionally use icon=" " (a space) to render consistent colored boxes since some Starlight icon names resolve to icons and others do not. Do not flag icon=" " as a placeholder issue for this file; treat this as a deliberate UX choice specific to this MDX page and avoid raising a placeholder-icon warning here.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-03-09T07:27:56.794Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 469
File: src/content/docs/guides/integrations/scim-integrations/azure-scim.mdx:95-107
Timestamp: 2026-03-09T07:27:56.794Z
Learning: Do not enforce the 3-space indentation rule for Steps component content as a hard style rule in MDX files under src/content/docs/**/*.mdx. Only flag/rectify it if it causes visible rendering problems in the UI. Otherwise, allow current formatting; apply this rule only when rendering issues are observed and document any fixes.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-03-09T07:32:38.426Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 467
File: src/content/docs/sso/guides/sso-user-attributes.mdx:108-148
Timestamp: 2026-03-09T07:32:38.426Z
Learning: In MDX code samples under src/content/docs (and similar conceptual snippets in scalekit-inc/developer-docs), when an example's sole purpose is to show how to access a specific value (e.g., reading JWT claims after token validation), omit error/non-happy-path handling to keep the snippet focused. Do not flag the absence of error paths in narrowly scoped conceptual snippets.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-03-17T16:01:50.487Z
Learnt from: dhaneshbs
Repo: scalekit-inc/developer-docs PR: 506
File: src/content/docs/authenticate/fsa/quickstart.mdx:851-853
Timestamp: 2026-03-17T16:01:50.487Z
Learning: In the Scalekit Python SDK docs, clarify that LogoutUrlOptions is not exported from the top-level scalekit package __init__.py. The correct import path in code samples or reviews is: from scalekit.common.scalekit import LogoutUrlOptions. Do not flag this import path as incorrect in documentation or code reviews; ensure examples reflect the proper import path to avoid confusion for users.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-04-27T07:13:48.244Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 628
File: src/content/docs/agentkit/tools/scalekit-optimized-tools.mdx:59-102
Timestamp: 2026-04-27T07:13:48.244Z
Learning: In AgentKit documentation MDX files, when showing Python `execute_tool` calls, treat `connection_name` as a supported argument (along with `tool_name`, `tool_input`, `identifier`, and `connected_account_id`). Do not flag `connection_name` as an invalid/unsupported parameter in these Python examples.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T13:40:40.902Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/content/docs/agentkit/connectors/handwritten-hubspot.mdx:95-126
Timestamp: 2026-05-07T13:40:40.902Z
Learning: For Quickstart code snippets in scalekit-inc/developer-docs connector docs (agentkit connector pages such as src/content/docs/agentkit/connectors/*.mdx), do not require explicit error/non-happy-path handling. Quickstart examples intentionally show only the happy path to reduce noise and help users complete a first working call quickly. In contrast, for more complete, reference-style examples outside of Quickstart flows, missing error-path handling can be flagged.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T13:41:31.574Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/content/docs/agentkit/connectors/handwritten-hubspot.mdx:453-499
Timestamp: 2026-05-07T13:41:31.574Z
Learning: In scalekit-inc/developer-docs, do not require a "what's next"/next-step signal at the end of agent connector documentation pages under src/content/docs/agentkit/connectors/ (for example, src/content/docs/agentkit/connectors/*.mdx). These pages may omit the typical next-step elements such as a frontmatter next link, a LinkCard, or a final forward-pointer paragraph; missing "what's next" sections on these connector pages should not be flagged as an issue.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T16:16:49.698Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/content/docs/agentkit/connectors/datadog.mdx:64-66
Timestamp: 2026-05-07T16:16:49.698Z
Learning: In scalekit-inc/developer-docs connector quickstart pages, do not flag the Step 4 heading text "Authorize and make your first call" as misleading for non-OAuth connectors (e.g., API key connectors). This heading is a standardized template label used intentionally across all connector types, regardless of connectorAuthType.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T16:42:20.842Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/content/docs/agentkit/connectors/confluence.mdx:70-72
Timestamp: 2026-05-07T16:42:20.842Z
Learning: For connector documentation MDX files under `src/content/docs/agentkit/connectors/` (e.g., agentkit connector pages), the `Tool list` section that renders via `<ToolList tools={tools} />` is injected/managed by `scripts/sync-agent-connectors.js`. If a hand-authored or partially hand-authored connector MDX file temporarily lacks the `Tool list` / `<ToolList tools={tools} />` section, do not flag it as a missing/incorrect section issue—it's expected to be re-injected by the generator in a later sync pass.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-13T14:20:54.610Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 690
File: src/content/docs/agentkit/connectors/monday.mdx:74-79
Timestamp: 2026-05-13T14:20:54.610Z
Learning: In connector documentation MDX pages under `src/content/docs/agentkit/connectors/` (e.g., `monday.mdx`, `clickup.mdx`), the “What you can do” capability bullet sections are auto-generated by the repo’s sync scripts from production API data. During code review, do not flag these sections for formatting/content issues or suggest manual rewrites, and treat edits to those bullets as expected only if the change came from rerunning the sync/update process. If a bullet needs to change, the correct path is to update the upstream API data and re-run the sync script, not to hand-edit the generated MDX.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-13T14:21:01.189Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 690
File: src/content/docs/agentkit/connectors/clickup.mdx:74-79
Timestamp: 2026-05-13T14:21:01.189Z
Learning: In connector MDX pages under src/content/docs/agentkit/connectors/ (e.g., clickup.mdx, monday.mdx), the "What you can do" capability bullet sections are auto-generated by the connector sync script (e.g., scripts/sync-agent-connectors.js). During code review, do not flag or require fixes for label/description mismatches or style/formatting issues within those auto-generated bullet lists, because manual edits will be overwritten by the next sync pass.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
📚 Learning: 2026-05-07T16:17:26.787Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/content/docs/agentkit/connectors/databricksworkspace.mdx:29-29
Timestamp: 2026-05-07T16:17:26.787Z
Learning: In scalekit-inc/developer-docs connector quickstart MDX pages under src/content/docs/agentkit/connectors/, use ### (H3) headings inside <Steps> components—not ## (H2)—because H2 renders too large. The page-level CSS override `.sl-markdown-content h3 { font-size: var(--sl-text-lg); }` should be kept in the frontmatter `head` block to size the step headings correctly. When reviewing these connector pages, do not flag ### headings inside <Steps> as incorrect.
Applied to files:
src/content/docs/agentkit/connectors/atlassianmcp.mdx
🔇 Additional comments (3)
src/components/templates/agent-connectors/_setup-atlassianmcp.mdx (1)
1-35: LGTM!src/components/templates/agent-connectors/index.ts (1)
6-6: LGTM!Also applies to: 107-107, 150-150
src/content/docs/agentkit/connectors/atlassianmcp.mdx (1)
1-85: LGTM!
…pabilities bullet, category slug; update redirect URI screenshot with arrow
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/data/agent-connectors/atlassianmcp.ts`:
- Around line 1359-1361: The description for the search parameter is misleading:
update the description for the search.query parameter used in the Atlassian
connector (the parameter named "query" in the search tool definition in
atlassianmcp.ts) so it correctly reflects that the tool searches across
Atlassian products (Jira and Confluence) rather than only Compass components;
replace "search for Compass components by name" with a concise phrase like "text
query to search across Jira and Confluence (issues, pages, components) by
name/content" to match the tool's documented behavior.
- Line 455: The description string for the createjiraissue parameter is
incorrect: update the createjiraissue.description value to describe a Jira
issue's description (e.g., "A human-readable description of the Jira issue to
create") instead of mentioning a Compass component; locate the createjiraissue
object in atlassianmcp.ts and replace the misleading text with a concise
Jira-specific description that accurately documents the field.
- Around line 913-917: The description for the parameter named 'labels' on
getconfluencespaces is incorrect (it mentions attaching labels to a Compass
component); update the parameter description so it accurately describes that
this option filters Confluence spaces by labels (e.g., "Filter Confluence spaces
by comma-separated labels" or similar). Locate the 'labels' entry in the
getconfluencespaces parameter/schema block in atlassianmcp.ts and replace the
misleading text with a short, accurate description reflecting label-based
filtering.
- Around line 1345-1349: The parameter description for the tool that looks up
Atlassian account IDs (the searchString parameter inside the lookupjiraaccountid
tool definition) is incorrect — it mentions filtering projects; update the
description to accurately reflect user lookup (e.g., "Text to filter users by
display name or email to find their Atlassian account ID") so it matches the
tool behavior; ensure you only change the description string for searchString
and leave name/type/required unchanged in the lookupjiraaccountid tool
configuration.
- Around line 937-941: Update the description for the "type" parameter used by
getConfluenceSpaces (symbol getconfluencespaces) so it correctly describes the
Confluence space type filter rather than Jira issue link relationships; replace
the current text with a concise explanation such as "Space type to filter by
(e.g. global or personal)" and optionally mention allowed values or expected
format, keeping the parameter name 'type', type 'string', and required:false
unchanged.
In `@src/data/agent-connectors/capabilities.json`:
- Line 9: Update the capability description in capabilities.json to accurately
state that the atlassianmcp_fetch tool only retrieves Atlassian product objects
(Jira/Confluence/Compass) by ARI or Atlassian URLs rather than arbitrary
external web pages; locate the capability string that currently reads "**Fetch
any URL** — retrieve external web content and docs directly from your AI
workflow" and change it to wording that explicitly references Atlassian
objects/ARIs and example Atlassian URLs so the UI reflects the true scope of
atlassianmcp_fetch.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: aefde6fe-f2b1-4587-b6a9-73d490ab6d1e
⛔ Files ignored due to path filters (1)
src/assets/docs/agent-connectors/atlassianmcp/copy-redirect-uri.pngis excluded by!**/*.png
📒 Files selected for processing (2)
src/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.json
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (11)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.json
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Prefer interface for defining object shapes in TypeScript
Use camelCase for variable names
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{ts,tsx,py,go,java,mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java,mdx,md}: Use the exact SDK variable names: Node.js (scalekit), Python (scalekit_client), Go (scalekitClient), Java (scalekitClient)
Never hard-code secrets or API keys in code examples; use environment variables
Include security comments that state the threat, why the pattern is required, and what can go wrong if omitted
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{ts,tsx,py,go,java}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java}: Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments with parameter descriptions, return values, and types
Comments should not duplicate the code; explain what the code does conceptually, not literally
Use better variable names and structure instead of comments to explain poorly written code
Explain unidiomatic or redundant code in comments; clarify why a specific pattern was chosen
Document exceptions and edge cases in code comments
Include links to external references (standards, RFCs, official documentation) in comments where helpful
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{ts,tsx,js,json}
📄 CodeRabbit inference engine (CLAUDE.md)
Use
pnpmfor package management
Files:
src/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.json
**/*.{ts,tsx,js,jsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
**/*.{ts,tsx,js,jsx,py,go,java}: Comments should not duplicate the code; comments should add value beyond what's obvious. Use better variable names and structure instead of using comments to explain poorly written code
Don't use comments to excuse unclear code. Comments should dispel confusion, not cause it. Ensure comments clarify rather than obscure purpose
Explain unidiomatic code in comments: comment on code that might seem unnecessary or redundant; explain why you chose a specific pattern
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments including parameter descriptions, return values, types, and descriptions
Document exceptions and edge cases in code comments
Include links to external references in code comments where helpful (standards, RFCs, official documentation)
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments in code
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{md,mdx,astro,ts}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{md,mdx,astro,ts}: Usepnpm pretty-quick --stagedvia pre-commit git hook to auto-format all staged.md,.mdx,.astro,.tsfiles with Prettier
Runpnpm formatto auto-format all.md,.mdx,.astro,.tsfiles before pushing changes
Files:
src/data/agent-connectors/atlassianmcp.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/data/agent-connectors/atlassianmcp.ts
src/data/agent-connectors/**
⚙️ CodeRabbit configuration file
src/data/agent-connectors/**: These are connector tool definition files (TypeScript data objects).
- Do NOT suggest extracting constants, refactoring data structures,
or renaming fields — these match the upstream API schemas.- Do NOT suggest adding parameters that don't exist in the upstream API.
- DO flag: incorrect types, missing required fields per the
AgentConnectorTool schema, and description text that contradicts
what the tool actually does.
Files:
src/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.json
🧠 Learnings (1)
📚 Learning: 2026-05-19T07:25:58.491Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 654
File: src/data/agent-connectors/asana.ts:3-1072
Timestamp: 2026-05-19T07:25:58.491Z
Learning: Files under `src/data/agent-connectors/` (e.g., connector implementations auto-generated from the tool-agent API, such as `asana.ts`) are generated by the sync script and already have tool-name and param-name uniqueness guaranteed by the source system. In code reviews, avoid recommending hand-written/hand-maintained integrity tests specifically for these generated connector files, since correctness is enforced upstream.
Applied to files:
src/data/agent-connectors/atlassianmcp.ts
🔇 Additional comments (1)
src/data/agent-connectors/atlassianmcp.ts (1)
782-782: No action needed. Theintegertypes at lines 782, 848, and 1202 are intentional:
limitusestype: 'number'(generic pagination)repliesPerCommentusestype: 'integer'(Confluence comment-specific parameter)firstusestype: 'integer'(GraphQL-style cursor pagination)This differentiation appears correct for mapping upstream Atlassian API specifications. Since this is a data-definition file matching upstream schemas, field types should not be modified without confirmation that upstream APIs require changes.
…y fetch capability, add cloudId workflow section
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx`:
- Around line 64-65: The response label currently drops the atlassianmcp_
prefix; update the text on the page to use the exact callable tool name
atlassianmcp_getaccessibleatlassianresources everywhere (replace occurrences of
getaccessibleatlassianresources with
atlassianmcp_getaccessibleatlassianresources) so it matches the tool used in
examples and follows the Atlassian MCP guideline about calling
atlassianmcp_getaccessibleatlassianresources first for cloudId retrieval.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 33e93f28-b445-4fc2-9d13-62b30bfde955
📒 Files selected for processing (4)
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdxsrc/components/templates/agent-connectors/index.tssrc/data/agent-connectors/atlassianmcp.tssrc/data/agent-connectors/capabilities.json
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - scalekit-starlight
- GitHub Check: Header rules - scalekit-starlight
- GitHub Check: Pages changed - scalekit-starlight
🧰 Additional context used
📓 Path-based instructions (16)
**/*.mdx
📄 CodeRabbit inference engine (.cursorrules)
**/*.mdx: Use clear, descriptive titles that explain the purpose of the document
Include comprehensive descriptions in frontmatter metadata
Organize content with logical heading hierarchy (H2, H3, H4)
Use tableOfContents property in frontmatter when content has multiple sections
Set appropriate sidebar labels for navigation in frontmatter
Use direct instruction writing style with phrases like 'This guide shows you how to...' and 'Create an authorization URL to...'
Use second person perspective ('your application', 'you receive', 'you must') in documentation
Keep sentences concise, aiming for under 25 words per sentence
Explain the 'why' in documentation with phrases like 'This prevents CSRF attacks by...' or 'Use this to validate that...'
Use action verbs in section headings: 'Store session tokens securely', 'Validate the state parameter', 'Exchange authorization code for tokens'
Use present tense for descriptions: 'Scalekit handles the complex authentication flow', 'The SDK provides methods to refresh tokens'
Use future tense for results: 'This will redirect users to...', 'You'll receive a JWT containing...', 'Scalekit returns an authorization code'
Use transition phrases between sections: 'After the user authenticates...', 'Once the state is validated...', 'Let's take a look at how to...'
Write 1-3 opening paragraphs that explain what users will accomplish, provide context about when/why, preview key concepts, and use direct instructional language
Begin introduction sections with a clear statement of what the guide covers and explain the problem being solved
Use collapsible sections in introduction for sequence diagrams, video demonstrations, data models, and JSON examples with appropriate icons
Use numbered format within Steps component:1. ## Titlewith all step content indented with exactly 3 spaces
Use action-oriented headings in step-by-step guides within Steps components
Include code examples in all 4 languages (Node.js, Python, Go, Java) within Steps co...
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
⚙️ CodeRabbit configuration file
**/*.mdx: You are reviewing Scalekit developer documentation written in MDX
(Astro + Starlight framework). Apply ALL of the following checks:Frontmatter
titleMUST be ≤ 60 characters and clearly state what the page does.descriptionMUST be ≤ 160 characters, action-oriented, unique per page.sidebar.labelMUST be present and ≤ 30 characters.sidebar.orderMUST be set on every page that lives inside a section
with siblings, to enforce the journey order in sidebar.config.ts.- Flag any missing
prev/nextlinks on pages that are clearly
part of a sequential flow (e.g., quickstart → implement-login →
complete-login → manage-session → logout).Voice & Style (CLAUDE.md standards)
- Voice: confident, direct, collaborative, instructional.
- Person: second person only ("you", "your application"). Reject "we",
"our", "the developer", "the user".- Tense: present tense for descriptions; imperative mood for instructions.
- Flag weasel words: "simply", "just", "easy", "straightforward",
"obviously", "of course", "note that".- Flag passive voice constructions where active voice is clearer.
- Headings must be sentence case, not Title Case (except proper nouns).
- Headings that match a real API parameter, method, or field name
(e.g.,contactID,xero_tenant_id,executeTool) should preserve
the original casing. Do NOT flag these as sentence-case violations.- No heading should end with a colon or period.
Content structure
- Journey how-to guides MUST contain numbered
<Steps>(Starlight
component). This does NOT apply tosrc/content/docs/cookbooks/**
(blog-style recipes — optional<Steps>,<Tabs>after</Steps>OK;
see cookbookspath_instructions).- Concept pages MUST NOT contain numbered steps — concepts explain, not instruct.
- API reference pages MUST list parameters in a table with Name / Type /
Required / Description columns.- Every page MUST end with a clear "what's next" signal — either a
next:f...
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
**/*.{yml,yaml,md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/browsecentral-labels.mdc)
**/*.{yml,yaml,md,mdx}: BrowseCentral labels should be maximum 3-5 words - keep concise but add context when needed
BrowseCentral labels should be action-oriented - start with verbs when possible
BrowseCentral labels should be specific and clear - add context when simple labels are ambiguous
BrowseCentral labels should be outcome-focused - describe what users accomplish and the context
BrowseCentral labels should use 'Action + Object' pattern (e.g., 'Invite users', 'Restrict sign-up', 'Set up SCIM')
BrowseCentral labels should use feature names (e.g., 'Enterprise SSO', 'Passwordless quickstart')
BrowseCentral labels should describe task completion (e.g., 'Run migrations', 'Migrate auth', 'Merge identities')
BrowseCentral labels should include specific context when needed (e.g., 'Configure Scalekit MCP server', 'Validate incoming API requests')
BrowseCentral labels should use integration context when applicable (e.g., 'Build MCP auth with your existing auth system')
BrowseCentral labels should avoid instructional prefixes: 'How to', 'Guide to', 'Implement', 'Configure', 'Learn', 'Understand'
BrowseCentral labels should avoid verbose phrases: 'Step-by-step guide', 'Complete tutorial', 'Detailed documentation'
BrowseCentral labels should avoid weak verbs: 'Enable', 'Allow', 'Provide', 'Support'
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/deno-docs-style.mdc)
**/*.{md,mdx}: Use sentence case for all titles and headings in MD/MDX documentation
Keep page titles short and descriptive (3–7 words when possible) in MD/MDX documentation
Use outcome-focused headings that describe results, not categories (e.g., 'Run a script' not 'Scripts')
Avoid gerunds in headings when an imperative works - prefer 'Configure proxies' over 'Configuring proxies'
Keep sidebar labels concise (1–3 words), use sentence case, and focus on outcomes or objects
Use sentence case in sidebar labels without punctuation
Set frontmatter title in sentence case with a clear outcome; description in one sentence (≤160 chars); sidebar.label as shorter form of title; enable tableOfContents on longer pages
Start documentation pages with a one-paragraph overview explaining what the page covers and when to use it
Present the primary use case (80% path) first in documentation, with edge cases later
Use numbered steps for task-focused sections in documentation, with each step beginning with a verb
Break up long documentation sections with subheadings every 3–6 paragraphs
Use asides for important notes, tips, cautions, and references in documentation
Provide runnable, minimal code examples that work as-is in documentation
Prefer CLI-first examples and show file layout when helpful in documentation
Label code blocks with titles for context (e.g., 'Terminal', 'main.ts') in documentation
Keep code block annotations brief and purposeful - annotate only what matters
Use consistent variable and file names across a documentation page
Use descriptive link text in documentation (e.g., 'See permission flags' not 'click here')
Prefer relative links for internal documentation pages and include anchors for section references
Reference APIs consistently using backticks for code, file names, CLI flags, and endpoints
Use backticks for code, file names, CLI flags, and endpoints in documentation
Use lists for options and features in documentation; tables only when comparisons are cleare...
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
**/*.{ts,tsx,py,go,java,mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java,mdx,md}: Use the exact SDK variable names: Node.js (scalekit), Python (scalekit_client), Go (scalekitClient), Java (scalekitClient)
Never hard-code secrets or API keys in code examples; use environment variables
Include security comments that state the threat, why the pattern is required, and what can go wrong if omitted
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdxsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{mdx,md}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{mdx,md}: All code examples must use<Tabs syncKey="tech-stack">format and include Node.js, Python, Go, and Java implementations (90% rule)
Use sentence case for all titles and headings in documentation
Use bold for first mention of important terms, UI elements, and dashboard paths (e.g., Dashboard > Authentication > Session Policy)
Use inline code for technical identifiers: variables, functions, endpoints, scopes, environment variables, file paths, and placeholders
Always include headers in tables; keep cell content concise and readable
Prefer fenced code blocks with language identifiers for all code; never use screenshots of code
Use descriptive link text; never use 'click here' or 'this' as link labels
Keep sentences simple, right-branching, and unambiguous; avoid ambiguous noun stacks and demonstrative pronouns
Use active voice; prefer 'Run the command' over 'The command should be run'
Use second person when giving instructions; address the reader as 'you'
Use present tense for procedures; 'This command installs…' not 'This command will install…'
Avoid hype, slang, and filler words like 'simply', 'just', 'obviously' in documentation
Use consistent terminology throughout; prefer standard names over synonyms
Explain security implications and threats for all security-related content
Use imperative verbs for procedure headings: 'Run a script' not 'Running a script'; 'Configure proxies' not 'Configuring proxies'
Headings must describe outcomes, not categories (good: 'Run a script'; bad: 'Scripts')
Split content into clear sections with descriptive, sentence-style titles that convey meaning without requiring the following paragraph
Keep paragraphs short; isolate critical points in their own short paragraphs
Begin sections and paragraphs with standalone topic sentences that preview content
Put the topic words at the beginning of topic sentences to support fast skimming
Put key takeaways and results at the top of documents and sections
Use bullets and tabl...
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
**/*.{md,mdx,astro,ts}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
**/*.{md,mdx,astro,ts}: Usepnpm pretty-quick --stagedvia pre-commit git hook to auto-format all staged.md,.mdx,.astro,.tsfiles with Prettier
Runpnpm formatto auto-format all.md,.mdx,.astro,.tsfiles before pushing changes
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdxsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
src/components/templates/agent-connectors/_section-*.mdx
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Custom agent connector sections must export
sectionTitlefrom the section template and omit the duplicate##heading from the component body
Files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy,gradle,xml,json}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Comments should not duplicate the code - avoid comments that simply restate what the code does; comments should add value beyond what's obvious from reading the code
Files:
src/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,json}
📄 CodeRabbit inference engine (CLAUDE.md)
Use
pnpmfor package management
Files:
src/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
src/data/agent-connectors/**
⚙️ CodeRabbit configuration file
src/data/agent-connectors/**: These are connector tool definition files (TypeScript data objects).
- Do NOT suggest extracting constants, refactoring data structures,
or renaming fields — these match the upstream API schemas.- Do NOT suggest adding parameters that don't exist in the upstream API.
- DO flag: incorrect types, missing required fields per the
AgentConnectorTool schema, and description text that contradicts
what the tool actually does.
Files:
src/data/agent-connectors/capabilities.jsonsrc/data/agent-connectors/atlassianmcp.ts
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
**/*.{js,ts,tsx,jsx,py,java,cs,go,cpp,c,rb,php,swift,kt,scala,rs,m,mm,groovy}: Good comments do not excuse unclear code - refactor the code to be self-explanatory instead of using comments to explain poorly written code; use better variable names, function names, and code structure
Comments should dispel confusion, not cause it - ensure comments clarify rather than obscure the code's purpose; avoid cryptic or joke comments
Explain unidiomatic code in comments - comment on code that might seem unnecessary or redundant and document why you chose a specific pattern over more common alternatives, especially when it deviates from team conventions
Provide links to the original source of copied code - always attribute code copied from external sources with URLs to Stack Overflow answers, GitHub repositories, or documentation
Include links to external references where helpful - reference standards, RFCs, and official documentation; link to relevant specifications when implementing protocols
Add comments when fixing bugs - document bug fixes with context about the issue, reference issue trackers and bug reports, and explain workarounds and their limitations
Use comments to mark incomplete implementations - use standard formats for TODO, FIXME, and NOTE comments with context about what needs to be done and reference issue trackers when possible
Always document public APIs with function/class comments - explain the purpose, parameters, return values, and exceptions; include usage examples for complex functions
Include file headers with copyright information, license, and authorship - provide a brief description of the file's purpose and document dependencies and requirements
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit inference engine (.cursor/rules/comment-standards.mdc)
Use JSDoc standards for all function, class, and complex logic comments in JavaScript/TypeScript - include parameter descriptions (
@param), return values (@returns), types (@type), and descriptions; document exceptions and edge cases
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Prefer interface for defining object shapes in TypeScript
Use camelCase for variable names
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,py,go,java}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx,py,go,java}: Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments with parameter descriptions, return values, and types
Comments should not duplicate the code; explain what the code does conceptually, not literally
Use better variable names and structure instead of comments to explain poorly written code
Explain unidiomatic or redundant code in comments; clarify why a specific pattern was chosen
Document exceptions and edge cases in code comments
Include links to external references (standards, RFCs, official documentation) in comments where helpful
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,tsx,js,jsx,py,go,java}
📄 CodeRabbit inference engine (AGENTS.md)
**/*.{ts,tsx,js,jsx,py,go,java}: Comments should not duplicate the code; comments should add value beyond what's obvious. Use better variable names and structure instead of using comments to explain poorly written code
Don't use comments to excuse unclear code. Comments should dispel confusion, not cause it. Ensure comments clarify rather than obscure purpose
Explain unidiomatic code in comments: comment on code that might seem unnecessary or redundant; explain why you chose a specific pattern
Use JSDoc/JavaDoc/docstring standards for function, class, and complex logic comments including parameter descriptions, return values, types, and descriptions
Document exceptions and edge cases in code comments
Include links to external references in code comments where helpful (standards, RFCs, official documentation)
Add comments when fixing bugs; reference issue trackers
Use standard formats for TODO, FIXME, and NOTE comments in code
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
**/*.{ts,js,mjs}
⚙️ CodeRabbit configuration file
**/*.{ts,js,mjs}: Do NOT enforce code-commenting style rules on these files.
Specifically, do not flag:
- Comments that "duplicate" or restate what the code does.
- Missing comments on bug fixes, workarounds, or issue references.
- Missing inline documentation or explanatory comments.
Code comments are at the author's discretion.
Files:
src/data/agent-connectors/atlassianmcp.tssrc/components/templates/agent-connectors/index.ts
🧠 Learnings (12)
📚 Learning: 2026-02-25T03:34:41.147Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 444
File: src/content/docs/agent-auth/start-agent-auth-coding-agents.mdx:31-31
Timestamp: 2026-02-25T03:34:41.147Z
Learning: In MDX files, import { Code } from 'astrojs/starlight/components' only if the MDX content actually uses the <Code> component. If the file uses only fenced code blocks (```), the import is not required. Apply this guideline to all MDX files (e.g., src/content/docs/**/*.mdx) to avoid unnecessary imports and reduce bundle size.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-02-25T18:41:00.639Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 446
File: src/content/docs/authenticate/m2m/api-auth-quickstart.mdx:78-78
Timestamp: 2026-02-25T18:41:00.639Z
Learning: Preserve full URLs inside code comments in MDX code blocks (bash/python/js) when the URLs are part of copyable examples. Do not flag these in code examples. Use relative paths in prose and hyperlinks within MDX; only enforce relative paths for markdown prose links, not for URLs inside code comments.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (.mdx files), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag links for missing `target="_blank"` or `rel="noopener"` (avoid adding raw HTML anchors just to include those attributes), and keep the approach consistent with existing docs styling.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-03-10T10:37:47.033Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-asana.mdx:15-15
Timestamp: 2026-03-10T10:37:47.033Z
Learning: In src/components/templates/agent-connectors/**/*.mdx, it is acceptable to reuse a single shared redirect URI screenshot (use-own-credentials-redirect-uri.png) across multiple steps within the same connector file, even if different UIs are shown. Do not flag this reuse as an issue; ensure this behavior is intentional and documented for reviewers.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-03-10T10:38:27.783Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 475
File: src/components/templates/agent-connectors/_setup-confluence.mdx:16-16
Timestamp: 2026-03-10T10:38:27.783Z
Learning: In all MDX templates under src/components/templates/agent-connectors, the pattern uses empty alt text (e.g., ![]()) for redirect URI screenshots like use-own-credentials-redirect-uri.png. This is intentional; reviews should not flag missing alt text for these images in this directory.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-03-12T16:26:39.422Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 483
File: src/components/templates/agent-connectors/_setup-bigquery.mdx:18-22
Timestamp: 2026-03-12T16:26:39.422Z
Learning: In agent-connectors MDX templates, it is acceptable to reuse shared Google OAuth screenshots stored under `@/assets/docs/agent-connectors/gmail/` (e.g., oauth-web-app.png, add-redirect-uri.png) across different Google-service connector templates (e.g., _setup-bigquery.mdx, _setup-google-ads.mdx). Do not flag cross-connector image path reuse within Google service connectors as an issue. This guideline applies to all files in this directory.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-04-25T07:22:18.321Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 633
File: src/components/templates/agent-connectors/_setup-heyreach.mdx:12-12
Timestamp: 2026-04-25T07:22:18.321Z
Learning: In this repo’s MDX documentation files, treat `@/...` paths as aliases that resolve to the `src/` directory (e.g., `@/assets/docs/foo/bar.png` -> `src/assets/docs/foo/bar.png`). When reviewing, do not flag `@`-prefixed image (or other asset) paths as broken; instead, verify that the corresponding physical file exists under `src/`.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-06T07:23:46.423Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 658
File: src/components/templates/agent-connectors/_section-before-tool-list-xero-common-patterns.mdx:15-63
Timestamp: 2026-05-06T07:23:46.423Z
Learning: In agentkit agent connectors documentation (files under src/components/templates/agent-connectors and src/content/docs/agentkit/connectors), do not require all four language tabs for SDK code examples. These docs may use only the language tabs relevant to the content (e.g., Node.js and Python). This is an exception to the standard multilingual guideline and should be applied consistently across connector docs.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-07T16:00:06.233Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/components/templates/agent-connectors/_section-after-setup-gmail-common-workflows.mdx:13-39
Timestamp: 2026-05-07T16:00:06.233Z
Learning: In documentation MDX files under src/components/templates/agent-connectors/ and src/content/docs/agentkit/connectors/, code examples are intentionally simplified. Do not require or flag missing error handling/failure paths (e.g., try/catch, retries, or explicit error returns) in these docs, even if the project’s general guideline expects both success and error paths in code examples.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-07T16:00:21.950Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 660
File: src/components/templates/agent-connectors/_section-after-setup-google_ads-common-workflows.mdx:10-18
Timestamp: 2026-05-07T16:00:21.950Z
Learning: In AgentKit agent connector documentation code examples located under src/components/templates/agent-connectors/** and src/content/docs/agentkit/connectors/** (MDX files), do not add explicit error handling in the sample code (e.g., no try/catch blocks or rejected-promise branches). These snippets are intentionally “success-path only” to keep the documentation concise, and this is an explicit exception to any general review guideline that requires both success and error paths in every code example.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-16T17:25:30.736Z
Learnt from: saif-at-scalekit
Repo: scalekit-inc/developer-docs PR: 693
File: src/content/docs/authenticate/mcp/troubleshooting.mdx:170-170
Timestamp: 2026-05-16T17:25:30.736Z
Learning: In this repo’s documentation (MD/MDX), external links should be written using plain Markdown link syntax: `[text](url)`. Do not flag external links for missing `target="_blank"` or `rel="noopener"`, and avoid converting Markdown links into raw HTML `<a>` tags just to add those attributes, since that would be inconsistent with the established doc pattern.
Applied to files:
src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx
📚 Learning: 2026-05-19T07:25:58.491Z
Learnt from: Pranesh-Raghu
Repo: scalekit-inc/developer-docs PR: 654
File: src/data/agent-connectors/asana.ts:3-1072
Timestamp: 2026-05-19T07:25:58.491Z
Learning: Files under `src/data/agent-connectors/` (e.g., connector implementations auto-generated from the tool-agent API, such as `asana.ts`) are generated by the sync script and already have tool-name and param-name uniqueness guaranteed by the source system. In code reviews, avoid recommending hand-written/hand-maintained integrity tests specifically for these generated connector files, since correctness is enforced upstream.
Applied to files:
src/data/agent-connectors/atlassianmcp.ts
🔇 Additional comments (3)
src/data/agent-connectors/atlassianmcp.ts (1)
1-1570: LGTM!src/data/agent-connectors/capabilities.json (1)
3-10: LGTM!src/components/templates/agent-connectors/index.ts (1)
6-6: LGTM!Also applies to: 76-76, 108-108, 151-151
| The `getaccessibleatlassianresources` response looks like this: | ||
|
|
There was a problem hiding this comment.
Use the exact tool name in the response label.
Line 64 drops the atlassianmcp_ prefix (getaccessibleatlassianresources), which is inconsistent with the callable tool name used elsewhere on the page.
Suggested fix
-The `getaccessibleatlassianresources` response looks like this:
+The `atlassianmcp_getaccessibleatlassianresources` response looks like this:As per coding guidelines: “For Atlassian MCP, Jira/Confluence tool calls require cloudId. Call atlassianmcp_getaccessibleatlassianresources first...”.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The `getaccessibleatlassianresources` response looks like this: | |
| The `atlassianmcp_getaccessibleatlassianresources` response looks like this: |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@src/components/templates/agent-connectors/_section-after-setup-atlassianmcp-common-workflows.mdx`
around lines 64 - 65, The response label currently drops the atlassianmcp_
prefix; update the text on the page to use the exact callable tool name
atlassianmcp_getaccessibleatlassianresources everywhere (replace occurrences of
getaccessibleatlassianresources with
atlassianmcp_getaccessibleatlassianresources) so it matches the tool used in
examples and follows the Atlassian MCP guideline about calling
atlassianmcp_getaccessibleatlassianresources first for cloudId retrieval.
1 participant
Summary
Preview
https://deploy-preview-{PR_NUMBER}--scalekit-starlight.netlify.app/agentkit/connectors/atlassianmcp/
Summary by CodeRabbit
New Features
Documentation