Agent Gallery
Agent Gallery OperationsOnboarding AgentsTrusted Agent Huddle

ServiceNow Agent

End-to-end walkthrough for onboarding a ServiceNow Agent via the Trusted Agent Huddle to the gallery using the AI Refinery runtime.

This walkthrough shows how to add the ServiceNow Agent via the Trusted Agent Huddle, upload its runtime definition, configure credentials, and run validation queries inside the Agent Gallery.

1. Create the ServiceNow Agent

From the Agent Gallery toolbar select Add Agent, pick the owning organisation, and fill out the metadata (identifier, display name, description, licence, and type) for the ServiceNow Agent.

Create ServiceNow agent form completed

Click Create Agent to provision the new entry and advance to its overview page.

ServiceNow agent overview after creation

2. Upload the runtime YAML

Use Edit → Runtime, confirm the runtime type matches your ServiceNow integration, and upload example.yaml with the agent definition below.

orchestrator:
  agent_list:
    - agent_name: "ServiceNow Agent"  # The name you choose for your ServiceNow agent. 

utility_agents:
  - agent_class: ServiceNowAgent
    agent_name: "ServiceNow Agent"  # The name you choose for your ServiceNow agent
    agent_description: "An assistant that can answer questions about ServiceNow documentations."
    config:
      servicenow_token: "SERVICENOW_TOKEN" # Required: Name of the environment variable holding the ServiceNow REST API token
      agent_card:   # Required: Details of the agent card retrieval
        public:  # Required: Type of the agent card (can be either public or private; here it is public)
          public_agent_card_path: "/.well-known/agent.json"  # Required: Path to the agent card
          rpc_url: <agent card URL>  # Required: Corresponding URL of the agent card
      wait_time: <timeout in seconds>  # Optional: Time (in seconds) the agent waits for A2A server response (default: 300)
      contexts: # Optional additional agent contexts
        - "date"
        - "chat_history"

Runtime tab with example.yaml uploaded for the ServiceNow agent

Uploaded YAML rendered in the runtime panel

You should see in the build status that the runtime is successfully uploaded.

3. Register configuration values

Open the Config tab, choose Add Configuration, and register each ServiceNow environment variable referenced in the YAML. Mark the variables as required and masked accordingly.

Configuration dialog listing ServiceNow variables

Environment VariableTypeRequiredDescription
API_KEYStringYesYour AI Refinery API key.
SERVICENOW_TOKENStringYesToken the agent uses when calling the ServiceNow REST API.

These values are prompted before a run.

4. Launch a validation run

Return to the agent overview and select Run. Choose the hardware preset, populate the configuration fields with the ServiceNow token, and run the agent.

Run dialog for the ServiceNow agent

5. Issue starter queries

Use the chat input to ask introductory questions that verify the ServiceNow Agent responds correctly—for example, request incident summaries or ticket status updates. Confirm the responses look correct.

Chat transcript showing successful ServiceNow responses

ServiceNow agent handling follow-up prompts

6. Wrap up the session

When validation is complete, shut down the run to release compute resources.