Skip to main content

Jama Connect Interchange Help

Validated example workflows

The following workflows have been validated in this early access release.

Workflow 1 – Requirement lookup from IDE

Tools likely to be used

Outcome

  • search_jama_entities
  • get_jama_entity_details
  • list_jama_projects
  • list_jama_entity_relationships
  • Retrieve requirement text

  • Retrieve metadata

  • Retrieve existing relationships

  • Surface requirement context inside the development environment

Example: Single prompt approach

  • Set context to the [Item Name] item in the Jama Connect project [Project Name].

    Print displays of:

    • Where the item is in the Project Tree.

    • The item description and all item metadata.

    • All item's relationships, including direction and relationship type.

Example: Multiple prompt approach

  • Set context to the Jama Connect project [Project Name].

  • Set context to [Item Name].

  • Print a display of the item description and all item metadata.

  • Print a display of all the item's relationships, including direction and relationship type.

  • Print a display of where the item is in the Project Tree.

Workflow 2 – Create or update requirement from code context

Tools likely to be used

Guardrails

  • create_jama_item
  • edit_jama_entity
  • get_jama_entity_type_details
  • list_jama_projects
  • get_jama_entity_details
  • search_jama_entities
  • Required fields must be provided.

  • Item types must be valid.

  • Workflow state rules are enforced.

  • Permission checks apply.

Example: Create and edit new item

  • Set context to Jama Connect project [Project Name].

  • Set the context to the [Folder Name] folder within the [Set Name] set.

  • Create a Jama Connect item with the following fields:

    Name – Test Manually Created item

    Description – This is a test created item

    *[Field Name] – [Field Value]

    *[Field Name] – [Field Value] 

  • Update the created item to add the current time in UTC in the description.

Example: Edit existing item

  • Set context to Jama Connect project [Project Name].

  • Edit the Jama Connect item Parental Controls PIN and content filtering description to say: “This has been updated by Jama Connect MCP.”

* Jama Connect 9.34+ only; not available in Jama Connect 9.33.

Workflow 3 – Create trace link between code and requirement

Tools likely to be used

Requirements

  • create_jama_entity_relationship
  • get_jama_entity_details
  • Valid source and target entity IDs.

  • Existing relationship type.

  • Proper permissions.

*Example: Create the Jama Connect link

  • Set the context to the Jama Connect project [Project Name].

  • Set the context to the Jama Connect folder [Parent Name] > [Folder Name].

  • In the current folder, create a new item with the following fields:

    Name – Authorization works properly.

    Description – The authorization is set up to properly authorize user access to their library.

  • In the current file, attach an annotation comment in the form // JamaID: ${id} to the method [MethodName]() with the new ID.

*Example: Review relationships for links

  • In the current file, review all annotation comments in the form // JamaID: ${id} and validate that all referenced items include both upstream and downstream relationships.

* Example prompts assume Java source code.

Workflow 4 – Baseline creation

Tools likely to be used

Constraints

  • create_jama_baseline
  • Applies to project scope.

  • Standard Jama Connect baseline rules apply.

Example prompts

  • Create a baseline of the [Folder Name] folder in the Jama Connect project [Project Name] named [New Baseline Name].

  • Create a baseline of the set with the ID [Set ID] named [New Baseline Name].