Skip to content

docs: improve README with updated connectors, SaaS options, MCP integ…#27364

Open
shrutisharma-sh wants to merge 1 commit intoopen-metadata:mainfrom
shrutisharma-sh:fix/readme-improvements
Open

docs: improve README with updated connectors, SaaS options, MCP integ…#27364
shrutisharma-sh wants to merge 1 commit intoopen-metadata:mainfrom
shrutisharma-sh:fix/readme-improvements

Conversation

@shrutisharma-sh
Copy link
Copy Markdown

Summary

This PR improves the README by addressing outdated and missing information to provide a clearer onboarding experience for users and contributors.

Changes

  • Updated connector count from 84+ to 120+

  • Expanded "Install and Run" section to include:

    • Self-host (Docker)
    • Live Sandbox
    • Free Managed Cloud (Collate)
  • Added MCP (Model Context Protocol) integration under Key Features

  • Introduced a Prerequisites section for contributors

Impact

These updates improve accuracy, reduce onboarding friction, and highlight newer features like MCP integration for the AI/LLM ecosystem.

References

Closes #<27009>

…ration, and prerequisites

Updated outdated connector count, added SaaS and sandbox options, introduced MCP integration, and included prerequisites for contributors.
@github-actions
Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@gitar-bot
Copy link
Copy Markdown

gitar-bot bot commented Apr 14, 2026

Code Review ✅ Approved

Updated the README with expanded connector documentation, SaaS deployment options, and new MCP integration details. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@github-actions
Copy link
Copy Markdown
Contributor

🟡 Playwright Results — all passed (25 flaky)

✅ 3631 passed · ❌ 0 failed · 🟡 25 flaky · ⏭️ 84 skipped

Shard Passed Failed Flaky Skipped
🟡 Shard 1 474 0 6 4
🟡 Shard 2 643 0 2 7
🟡 Shard 3 645 0 8 1
🟡 Shard 4 622 0 4 22
✅ Shard 5 612 0 0 42
🟡 Shard 6 635 0 5 8
🟡 25 flaky test(s) (passed on retry)
  • Features/DataAssetRulesDisabled.spec.ts › Verify the Pipeline entity item action after rules disabled (shard 1, 2 retries)
  • Features/DataAssetRulesDisabled.spec.ts › Verify the Database entity item action after rules disabled (shard 1, 1 retry)
  • Features/DescriptionSuggestion.spec.ts › Reject All Suggestions (shard 1, 1 retry)
  • Pages/AuditLogs.spec.ts › should apply both User and EntityType filters simultaneously (shard 1, 1 retry)
  • Pages/Customproperties-part1.spec.ts › Timestamp (shard 1, 1 retry)
  • Pages/UserCreationWithPersona.spec.ts › Create user with persona and verify on profile (shard 1, 1 retry)
  • Features/BulkEditEntity.spec.ts › Glossary (shard 2, 1 retry)
  • Features/ChangeSummaryBadge.spec.ts › AI badge should NOT appear for manually-edited descriptions (shard 2, 1 retry)
  • Features/Permissions/GlossaryPermissions.spec.ts › Team-based permissions work correctly (shard 3, 1 retry)
  • Features/RestoreEntityInheritedFields.spec.ts › Validate restore with Inherited domain and data products assigned (shard 3, 2 retries)
  • Features/RestoreEntityInheritedFields.spec.ts › Validate restore with Inherited domain and data products assigned (shard 3, 1 retry)
  • Features/RestoreEntityInheritedFields.spec.ts › Validate restore with Inherited domain and data products assigned (shard 3, 1 retry)
  • Features/RTL.spec.ts › Verify Following widget functionality (shard 3, 1 retry)
  • Flow/CustomizeWidgets.spec.ts › Activity Feed Widget (shard 3, 1 retry)
  • Flow/NotificationAlerts.spec.ts › Alert operations for a user with and without permissions (shard 3, 1 retry)
  • Flow/PersonaFlow.spec.ts › Set default persona for team should work properly (shard 3, 1 retry)
  • Pages/Customproperties-part2.spec.ts › entityReferenceList shows item count, scrollable list, no expand toggle (shard 4, 1 retry)
  • Pages/DataContractsSemanticRules.spec.ts › Validate Description Rule Is_Set (shard 4, 1 retry)
  • Pages/DataContractsSemanticRules.spec.ts › Validate Description Rule Is_Not_Set (shard 4, 1 retry)
  • Pages/Domains.spec.ts › Rename domain with tags and glossary terms preserves associations (shard 4, 1 retry)
  • Pages/Lineage/LineageFilters.spec.ts › Verify lineage schema filter selection (shard 6, 1 retry)
  • Pages/Lineage/LineageRightPanel.spec.ts › Verify custom properties tab IS visible for supported type: searchIndex (shard 6, 1 retry)
  • Pages/Users.spec.ts › Permissions for table details page for Data Consumer (shard 6, 1 retry)
  • Pages/Users.spec.ts › Check permissions for Data Steward (shard 6, 1 retry)
  • VersionPages/EntityVersionPages.spec.ts › Directory (shard 6, 1 retry)

📦 Download artifacts

How to debug locally
# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test Add this label to run secure Github workflows on PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants