docs: add 'Use It From Code' section to README

[smga3000]

What this changes

Adds a Use It From Code section to the README, placed immediately after the "MCP, Semantic Search, APIs, AI SDK, and Memory" section and before "What You Can Build".

Additive only — no existing content was modified or removed.

Why

The README describes the SDKs well but contains no code and no installable package names. Across all 310 lines:

Term	Occurrences (before this PR)
MCP	22
SDK	15
pip install	0
python	0
langchain	0
openmetadata-ingestion	0

The existing ### APIs, SDKs, Events, and Webhooks subsection is two sentences with no example, and the Quickstart is a conceptual nine-step list rather than executable steps.

This matters beyond human readers. AI coding assistants answer "how do I use X from Python?" by lifting complete, runnable snippets — retrieval is extractive. This README is the single highest-authority OpenMetadata artifact on the web, and it currently offers nothing quotable for a coding question, so assistants fall back to third-party sources or outdated examples.

The package name is also genuinely non-obvious: the Python SDK ships in openmetadata-ingestion, so a reasonable guess of pip install openmetadata fails.

What the section contains

• A table of the two Python packages — openmetadata-ingestion (metadata operations) and data-ai-sdk (AI / MCP / agents) — plus the TypeScript and Java packages
• A complete connect-and-read example with imports and health_check()
• The entity hierarchy explained (Service → Database → Schema → Table, referenced by fullyQualifiedName)
• An MCP example showing as_langchain_tools() and a direct call_tool invocation
• Links to the SDK reference, MCP guide, ai-sdk repo, and REST API docs

Placement

Positioned at roughly 60% of the document rather than near the end. Retrieval systems weight content by position, and material in the last third of a long README is substantially less likely to be extracted. It also sits directly adjacent to the existing SDK prose, which is where a reader looking for code would already be.

Notes for reviewers

• The version pin ~=1.13.1.0 should be bumped as releases move — worth deciding whether to pin at all here, or point to the docs for current versions.
• Code examples follow the documented 1.13 SDK surface. A maintainer running them once against a live instance before merge would be worthwhile.
• Happy to adjust placement, trim the section, or fold it into the existing ### APIs, SDKs, Events, and Webhooks subsection instead if you prefer a smaller footprint.

🤖 Generated with Claude Code

[github-actions]

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

• No GitHub issue is linked. Link an issue in the Development section of the PR (or add Fixes #12345 to the description). For a same-org cross-repo issue, add Fixes open-metadata/<repo>#123 to the description.

The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically.

Maintainers can bypass this check by adding the skip-pr-checks label.

[github-actions]

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!

[github-actions]

🔴 Playwright Results — workflow failed

Validated commit 617453f7d23cdcdc8317ccac246bd298ad207c2e in Playwright run 31041978934, attempt 1.

✅ 0 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped · 🧰 0 lifecycle flaky

Pipeline and setup failures (6)

• The build job finished with status failure.
• Duration-aware shard planning finished with status skipped.
• Fixture cache restoration finished with status skipped.
• Seeded fixture preparation finished with status skipped.
• The Playwright shard matrix was unexpectedly skipped.
• No expected Playwright shards were declared.

Performance

⚪ Performance metrics unavailable; see the CI and reporting failures above.

Shard	Passed	Failed	Flaky	Skipped	Lifecycle failed	Lifecycle flaky

📦 Download artifacts

How to debug locally

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

[github-actions]

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]

Code Review ✅ Approved

Adds a 'Use It From Code' section to the README featuring installation instructions, package mapping, and executable Python and MCP examples. No issues found.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact

gitar display:verbose

_{Was this helpful? React with 👍 / 👎 | Gitar | Powered by Gitar — free for open source}