Skip to main content

Jama Connect Help

Implement the adapter interface

Every request and successful response identifies the adapter format with contractVersion: 1.

The request can contain:

Element

Purpose

systemPrompt

Provides the active Jama Connect system instructions.

messages

Provides ordered user, assistant, tool-call, and tool-result history.

tools

Describes the Jama Connect operations available to the model.

forceToolName

Optionally requires selection of one supplied tool.

The adapter must preserve message order, part order, tool-call identifiers, tool names, arguments, and tool-result correlation when translating provider requests and responses.

A successful response contains:

Element

Purpose

contractVersion

Identifies the Jama Intelligence Gateway adapter response format.

message

Contains the assistant text, reasoning, or tool request.

endTurn

Tells Jama Connect whether the response is final or Jama Connect must continue a tool workflow.

usage

Optionally reports input and output token usage.

When the model requests a Jama Connect tool, the adapter returns a unique tool-call identifier and endTurn: false. Jama Connect validates and executes the supported operation, then sends a later request containing the corresponding tool result.

For complete JSON schemas, examples, provider translations, and automated test vectors, use the version-matched GitHub starter kit.

Return a non-2xx status when the adapter can’t produce a valid successful response. Use the most accurate status available and return a safe diagnostic body.

Status

Typical meaning

400 or 422

The request is invalid or incompatible with the adapter format.

401 or 403

An endpoint or upstream access policy rejected the request.

404

The configured operation path does not exist.

429

The adapter or provider is throttling requests.

500

The adapter has a configuration or internal failure.

502 or 503

The provider invocation or upstream service failed.

Don’t include provider credentials, access tokens, raw secrets, or unnecessary customer content in an error response.