Skip to content

Add ISV integration guidance to SDK README#263

Merged
denelon merged 6 commits into
microsoft:mainfrom
denelon:denelon/sdk-readme-isv-guidance
May 14, 2026
Merged

Add ISV integration guidance to SDK README#263
denelon merged 6 commits into
microsoft:mainfrom
denelon:denelon/sdk-readme-isv-guidance

Conversation

@denelon

@denelon denelon commented May 6, 2026

Copy link
Copy Markdown
Collaborator

📖 Description

Add practical integration guidance to the SDK README for external consumers (ISVs integrating MXC into agentic applications). The npm readme is the first thing consumers read, and currently lacks coverage of common friction points.

🔗 References

Resolves https://github.com/microsoft/mxc/issues/262

🔍 Validation

Documentation-only change. Verified markdown renders correctly and code examples are syntactically valid TypeScript.

✅ Checklist

📋 Issue Type

  • Bug fix
  • Feature
  • Task
Microsoft Reviewers: Open in CodeFlow

@denelon denelon requested a review from bbonaby May 6, 2026 23:08
Comment thread sdk/README.md Outdated
Comment thread sdk/README.md Outdated
Comment thread sdk/README.md Outdated
Comment thread sdk/README.md Outdated
@denelon denelon marked this pull request as ready for review May 7, 2026 15:06
Comment thread sdk/README.md Outdated
Comment thread sdk/README.md Outdated
@bbonaby

bbonaby commented May 13, 2026

Copy link
Copy Markdown
Collaborator

@copilot resolve the merge conflicts in this pull request

@bbonaby bbonaby requested a review from a team May 13, 2026 05:05

@jsidewhite jsidewhite left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

:shipit:

@denelon

denelon commented May 13, 2026

Copy link
Copy Markdown
Collaborator Author

@copilot resolve the merge conflicts in this pull request

@denelon denelon force-pushed the denelon/sdk-readme-isv-guidance branch from c546ef6 to 50c541f Compare May 13, 2026 16:24
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Demitrius Nelon and others added 3 commits May 13, 2026 09:33
Add practical sections for external consumers:
- Common Pitfalls (stderr merging, createConfigFromPolicy gotcha,
  elevation failures, timeout defaults)
- Recommended Policy for Agentic Workloads
- Error Handling patterns
- Integration Checklist
- Elevation requirement in Prerequisites

Resolves #262

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@denelon denelon force-pushed the denelon/sdk-readme-isv-guidance branch from 50c541f to 179aa85 Compare May 13, 2026 16:34
denelon and others added 3 commits May 13, 2026 09:41
Addresses review feedback from richiemsft: adds build-mac.sh documentation,
mxc-exec-mac binary reference, and Seatbelt backend entry to the containment
backends table.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@denelon denelon merged commit a29130b into microsoft:main May 14, 2026
20 checks passed
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.

5 participants