Skip to content

docs: add platform connectivity and deployment guidance - #407

Merged
AutomateIP merged 1 commit into
itential:develfrom
AutomateIP:docs/platform-connectivity-deployment
Aug 13, 2026
Merged

docs: add platform connectivity and deployment guidance#407
AutomateIP merged 1 commit into
itential:develfrom
AutomateIP:docs/platform-connectivity-deployment

Conversation

@AutomateIP

Copy link
Copy Markdown
Collaborator

Summary

Adds deployment guidance covering itential-mcp's platform connectivity model:
one connection per server process, and the recommended pattern of pointing
platform.host directly at a highly-available/load-balanced Itential
Platform endpoint rather than building multi-endpoint routing into
itential-mcp itself.

Changes

  • docs/deployment.md (new): platform connectivity recommendation, why it
    works without client-side sticky sessions, the TTL-based reauthentication
    itential-mcp already performs transparently (platform.ttl /
    ITENTIAL_MCP_PLATFORM_TTL), the connection/state model (one platform
    connection per process, immutable config, no per-request state), and
    guidance for scaling itential-mcp itself behind its own load balancer.
  • docs/index.md: link the new doc under "Configuration & Security".

Docs-only change; no application code touched.

Testing

  • Manual review of doc content and links

Related Issues

N/A

Document itential-mcp's connection model: one platform connection per
server process, and the recommended pattern of pointing platform.host
directly at a highly-available/load-balanced Itential Platform endpoint
rather than building multi-endpoint routing into itential-mcp itself.

Covers why this works without client-side sticky sessions, the TTL-based
reauthentication itential-mcp already performs transparently, and what
to plan for when scaling itential-mcp itself behind its own load
balancer (independent of platform-side HA).

Add to docs/index.md's Configuration & Security section.
@AutomateIP AutomateIP added the documentation Improvements or additions to documentation label Aug 13, 2026
@AutomateIP
AutomateIP merged commit b5f185a into itential:devel Aug 13, 2026
7 checks passed
AutomateIP added a commit to AutomateIP/itential-mcp that referenced this pull request Aug 13, 2026
Covers all 13 commits since v0.13.3 (itential#395-itential#407), grouped by
feature/fix/security/chore/docs. Also corrects the stale '9 Dependabot
advisories remain open' note in the 0.13.3 entry -- that hold was
lifted in itential#399 and re-triage confirmed 0 open advisories as of
2026-08-07.
AutomateIP added a commit that referenced this pull request Aug 13, 2026
Covers all 13 commits since v0.13.3 (#395-#407), grouped by
feature/fix/security/chore/docs. Also corrects the stale '9 Dependabot
advisories remain open' note in the 0.13.3 entry -- that hold was
lifted in #399 and re-triage confirmed 0 open advisories as of
2026-08-07.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant