@morphism-systems/sdk
v0.1.1
Published
Embeddable governance SDK — run Morphism categorical governance checks from any platform
Downloads
254
Readme
@morphism-systems/sdk
Embeddable governance SDK. Run governance checks -- kappa computation, drift detection, validation, and proof witness queries -- from any TypeScript/JavaScript platform.
About
Embed Morphism governance checks into your own tools, CI pipelines, or platforms. The SDK provides a typed client with methods for convergence computation, drift detection, validation, and proof witness queries. Ships as both ESM and CJS. Requires a Pro plan or above.
Note: The REST API (
https://api.morphism.systems) is in development. The SDK currently supports local MCP-based governance.
Installation
npm install @morphism-systems/sdkQuick Start
import { MorphismClient } from '@morphism-systems/sdk'
const client = new MorphismClient({
credential: process.env.MORPHISM_API_KEY!,
})
// Full governance check with pass/fail verdict
const result = await client.runGovernanceCheck()
if (result.pass) {
console.log(`Governance check passed (kappa=${result.kappa.toFixed(4)})`)
} else {
console.log(`Governance check failed: ${result.drift_count} drift items`)
for (const item of result.drift_items) {
console.log(` [${item.severity}] ${item.file}: ${item.description}`)
}
}What's included
| Method | Description |
|--------|-------------|
| runGovernanceCheck() | Compose all checks into a single pass/fail verdict |
| computeKappa() | Convergence metric (κ → 0 = fully compliant) |
| checkDrift() | Detect drift items with severity and file location |
| validate() | Run validation pipeline, return violations list |
| getProofWitnesses() | Query proof witnesses from governance runs |
CI/CD gate
const result = await client.runGovernanceCheck({
kappa_threshold: 0.5, // Fail if kappa >= 0.5
max_drift_items: 3, // Fail if more than 3 drift items
})
process.exit(result.pass ? 0 : 1)Pass/fail logic
runGovernanceCheck() composes individual checks into a single verdict:
- Kappa threshold — kappa must be below threshold (default: 1.0, meaning convergent)
- Drift limit — drift item count must be within limit (default: unlimited)
- High-severity drift — any high-severity drift item auto-fails
- Validation errors — any error-level violation auto-fails
Documentation
Full reference: https://morphism-systems.github.io/morphism/
