Run a governed agent from Python

Install and authenticate

Install the published kimss package, store KIMSS_API_KEY outside source control, and call APIs with X-Kimss-Key or bearer tokens plus X-Workspace-ID when one key spans workspaces.

pip install kimss pulls the supported client. Never commit workspace keys; use secret stores in CI and production.

Use the supported agent surface

Agent run and create, model completions, file upload, and vector-store creation form the core SDK—prefer /v1/agents/run for new agent execution paths.

Conversation continuation uses conversation_id in the SDK. MCP exposes run agent, create agent, complete, upload, and create vector store for IDE workflows.

Example flow

Configure credentials, create or select an agent, run with messages, and inspect usage impact on workspace credits—repeat in staging before production keys.

Full code samples and edge cases live in /docs/python_sdk_mcp. Public REST shapes are documented at /docs/api_docs, not production Swagger.

Keep the boundary explicit

The SDK does not wrap every billing, admin, SCIM, or backoffice route—verify shipped documentation before assuming a client method exists.

Migrate legacy assistant helpers via /assistants-to-v1-migration. Enterprise MCP policy: /mcp-enterprise-ai.

Implementation patterns for Python SDK and MCP integration

Teams succeed with Python SDK and MCP integration when they treat Kimss as the integration boundary: applications never hold Foundry secrets, every call includes workspace context, and operators review credit trends before expanding model access.

Start in a non-production workspace. Wire SDK agent runs against POST /v1/agents/run or POST /v1/models/completions using X-Kimss-Key or a bearer token. Validate streaming, tool invocation, and error paths your production clients rely on.

Document which Entra groups map to which workspace roles. Align developer workspace keys with monthly credit pools so finance sees predictable units rather than surprise token spikes on the Azure invoice.

Publish an internal integration checklist: required headers, workspace identifiers, approved models, and escalation paths when credits approach exhaustion.

Use /docs/architecture to confirm whether your tenant uses direct Foundry routing or an optional APIM path. Do not enable gateway-only modes in production until end-to-end verification passes in your environment.

When CI and local development spans multiple internal products, give each product its own API key or sub-workspace budget so attribution stays legible in usage aggregates and billing ledgers.

Common mistakes when rolling out Python SDK and MCP integration

The costliest errors are shared Foundry keys in microservices, skipping workspace headers on multi-tenant keys, and migrating user-facing flows before server-side credit enforcement is tested.

Embedding one project key in every service bypasses Kimss RBAC and makes revocation a company-wide fire drill. Issue workspace-scoped keys per service or per environment instead.

Assuming legacy /assistant_* behavior matches /v1 governance causes silent gaps in metering or identity. Inventory clients with /assistants-to-v1-migration and retire legacy paths deliberately.

Treating Kimss Credits as cosmetic reporting rather than enforced pools invites overrun. Configure exhaustion policies in staging and confirm blocked requests behave as product management expects.

Publishing internal runbooks that reference production Swagger instead of /docs/api_docs creates integration drift. The public API reference is the supported contract for external integrators.

Skipping staging verification for streaming and tool calls leads to production surprises. Exercise the same client libraries and timeouts you expect under peak load.

Next steps for Python SDK and MCP integration

Create a workspace, read /why-kimss for positioning, follow /python-sdk-mcp-quickstart for code, and engage /enterprise when contractual isolation, capacity, or onboarding differ from self-serve plans.

Self-serve teams typically progress: signup, first agent run via SDK, credit pool configuration, Entra SSO for Studio users, then wider rollout to internal consumers or customer tenants.

For Python SDK and MCP integration, schedule a monthly review of usage aggregates, ledger entries, and agent inventory. Remove unused keys, archive obsolete agents, and adjust group budgets after major launches.

Customer-facing ISVs should pair Kimss workspace design with /multi-tenant-ai-security and /ai-rbac-and-identity so each end customer receives isolated agents, files, and usage rows.

Track product changes at /changelog and deeper narratives at /insights so your platform team does not miss SDK or API shifts that affect deployed clients.

Documentation and honest scope

Kimss documents the supported integration surface at /docs/api_docs and system design at /docs/architecture—avoid assuming every internal admin route is available in the public SDK or MCP server.

Platform engineers should bookmark /docs/api_docs as the contract for external integrators. When product management requests a feature, verify whether it exists on /v1, requires an admin API, or needs net-new development before committing customer timelines.

Kimss Credits, Entra SSO, workspace RBAC, and PostgreSQL isolation are first-class product capabilities—not marketing adjectives. Validate them in your tenant with test workspaces and realistic agent workloads rather than slide-deck assumptions.

Optional Azure API Management integration remains documented as an advanced path. Production enablement should follow your organization's verification checklist for gateway telemetry and routing parity with direct Foundry execution.

When questions fall outside public documentation, enterprise customers can reach Kimss via /enterprise. Self-serve builders can use in-product support after signup.

Verify before you scale

Treat Kimss as production infrastructure: validate identity, credits, and routing in a staging workspace, read /docs/api_docs for the supported contract, and expand pools only after usage patterns are understood.

Platform teams should run monthly reviews of workspace keys, agent inventory, and ledger entries. Remove unused credentials, archive obsolete agents, and align group budgets with teams that actually ship. Pair Kimss attribution with Azure Cost Management for infrastructure truth—the credits layer governs product behavior; Azure still bills underlying Foundry consumption.

When you need help beyond public documentation, self-serve builders use in-product support after signup; enterprise buyers start at /enterprise for onboarding, capacity, and contractual questions. Product changes publish at /changelog so integrators can track SDK and API shifts over time.