Skip to content

feat: add Miro agent connector setup guide and tool docs#604

Merged
Pranesh-Raghu merged 3 commits into
mainfrom
preview/miro-connector
Apr 14, 2026
Merged

feat: add Miro agent connector setup guide and tool docs#604
Pranesh-Raghu merged 3 commits into
mainfrom
preview/miro-connector

Conversation

@Pranesh-Raghu
Copy link
Copy Markdown
Collaborator

@Pranesh-Raghu Pranesh-Raghu commented Apr 14, 2026

  • Complete 5-step OAuth setup guide (create Miro app, copy redirect URI, register URI + copy credentials, configure scopes, add to Scalekit)
  • Usage examples with Node.js and Python proxy API calls
  • Full tool list for all 105 Miro tools with parameter tables
  • Enterprise-only and experimental API notices
  • 5 accurate Scalekit/Miro UI screenshots
  • Export SetupMiroSection and UsageMiroSection from templates index

Summary by CodeRabbit

  • Documentation
    • Added a Miro agent connector setup guide with step-by-step OAuth app registration, redirect URI registration, required scopes, and cautions/tips.
    • Added usage docs with Node.js and Python examples showing authorization flow and proxy API calls to list boards and create sticky notes.
    • Added a comprehensive Miro connector reference listing available operations, parameters, notes on Enterprise-only tools, and experimental mind‑map warnings.

- Complete 5-step OAuth setup guide (create Miro app, copy redirect URI,
  register URI + copy credentials, configure scopes, add to Scalekit)
- Usage examples with Node.js and Python proxy API calls
- Full tool list for all 105 Miro tools with parameter tables
- Enterprise-only and experimental API notices
- 5 accurate Scalekit/Miro UI screenshots
- Export SetupMiroSection and UsageMiroSection from templates index
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 14, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • src/assets/docs/agent-connectors/miro/scalekit-search-miro.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4d2ec6f7-c279-4b8d-a54d-2ae58ba059a5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

Adds Miro connector documentation: setup and usage MDX templates, a comprehensive Miro reference page listing tools and parameters, and exports the new templates from the agent-connectors index.

Changes

Cohort / File(s) Summary
Miro Connector Templates
src/components/templates/agent-connectors/_setup-miro.mdx, src/components/templates/agent-connectors/_usage-miro.mdx
New MDX pages: setup guide for Miro OAuth and usage guide with Node.js and Python examples (authorization link generation and proxy API calls). Includes Asides, images, and code samples.
Miro Reference Docs
src/content/docs/reference/agent-connectors/miro.mdx
New reference page registering Miro connector: frontmatter, overview, reused setup/usage components, tool list (miro_* tools) with parameter tables, Enterprise/tooling notes, and token introspection entry.
Module Exports
src/components/templates/agent-connectors/index.ts
Added named exports: SetupMiroSection and UsageMiroSection to expose the new MDX template components.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • ravibits
  • saif-at-scalekit
  • amitash1912
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: adding comprehensive Miro agent connector documentation including setup guide, usage examples, and tool reference documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch preview/miro-connector

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 14, 2026

Deploy Preview for scalekit-starlight ready!

Name Link
🔨 Latest commit 21791a1
🔍 Latest deploy log https://app.netlify.com/projects/scalekit-starlight/deploys/69de0410a7928100083e5ac0
😎 Deploy Preview https://deploy-preview-604--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/reference/agent-connectors/miro.mdx`:
- Around line 241-245: The miro_boards_list docs claim support for filters but
lack the required Name|Type|Required|Description parameter table; update the
generator script scripts/sync-agent-connectors.js to emit a parameter table for
the miro_boards_list tool (or remove the filter wording if filters are not
supported). Locate the miro_boards_list metadata in the agent connectors source
and ensure the generator writes rows for each supported filter (e.g.,
team/teamId, project/projectId, owner/ownerId, search/query) with correct Type
and Required flags and a short Description, then re-run the script to regenerate
src/content/docs/reference/agent-connectors/miro.mdx so the API reference
includes the table.
🪄 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: 583338be-6e21-4ef4-831e-37b4bf20c4c7

📥 Commits

Reviewing files that changed from the base of the PR and between 283b3fa and 3b41aa5.

⛔ Files ignored due to path filters (5)
  • src/assets/docs/agent-connectors/miro/add-credentials.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/miro/configure-miro-connection.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/miro/miro-create-app.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/miro/miro-oauth-credentials.png is excluded by !**/*.png
  • src/assets/docs/agent-connectors/miro/scalekit-search-miro.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • src/components/templates/agent-connectors/_setup-miro.mdx
  • src/components/templates/agent-connectors/_usage-miro.mdx
  • src/components/templates/agent-connectors/index.ts
  • src/content/docs/reference/agent-connectors/miro.mdx

Comment thread src/content/docs/reference/agent-connectors/miro.mdx
@Pranesh-Raghu Pranesh-Raghu merged commit ceb94d0 into main Apr 14, 2026
1 check passed
@saif-at-scalekit saif-at-scalekit deleted the preview/miro-connector branch May 7, 2026 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant