Skip to content

Repository files navigation

Spotfire Copilot™ Documentation

Spotfire Copilot™ is a generative-AI assistant embedded directly in Spotfire® Analyst and Web Player. It pairs a containerised backend orchestrator with a client-side panel so analysts can ask questions in natural language, build visualizations, query their data, and draw on curated knowledge bases (RAG).

Beyond these built-in capabilities, Spotfire Copilot is significantly enhanced by external A2A (Agent-to-Agent) agents. Through the Agent Registry you can develop and deploy your own agents — whether use-case-targeted (tuned to a specific domain, dataset, or workflow) or general-purpose — that give Copilot entirely new skills, tools, and data access. External agents are the primary way to extend what Copilot can do for your users, turning it from an out-of-the-box assistant into a platform tailored to your organisation.

This repository is the canonical home for the Spotfire Copilot documentation.

Component versions

Component Latest version
Backend Services (Orchestrator + Data Loaders) 2.3.7
Spotfire client packages 2.3.6
Kubernetes / Helm charts (DeepAgents + MCP servers) 0.3.5
Ecosystem Agent Server 1.0.7
Ecosystem Agent MCP Servers 1.1.0
Agent Registry Toolkit 1.1.0

Where to start

The documentation covers several audiences. Pick the path that matches what you want to do — you don't need to read everything, and only the core platform path is required for every deployment.

🆕 I'm new and want to understand Spotfire Copilot

Read the introduction above, then skim the Agent Registry Overview to see how Copilot is extended with agents. That's enough to understand the whole picture before you install anything.

🚀 I'm deploying the core platform (administrator)

This is the required baseline. Follow it in order:

  1. Backend Setup — stand up the orchestrator (required first).
  2. Admin Console — create users and OAuth2 clients, then operate the deployment.
  3. Data Loaders — populate the knowledge base for RAG.
  4. Frontend Setup — enable the Copilot panel in Spotfire clients.

After this, Copilot is live. Everything below is optional but strongly recommended to unlock its full potential.

🧩 I want to add ready-made agents (administrator)

Extend a running deployment with pre-built, domain-targeted agents:

  1. Agent Registry Overview — understand the registry containers and what each hosts.
  2. Agent Registry Installation Guide — host the Domain Agents container.
  3. Ecosystem Agents — deploy the LangGraph DeepAgents server (OSS or Licensed) and the MCP servers that back each agent.

🛠️ I'm building my own agents (developer)

  1. Agent Registry Overview — see where custom agents fit.
  2. Agent Registry Toolkit User Guide — build and serve your own agents with the toolkit and MCP dev server.

📊 I'm an analyst using the agents (end user)

Go straight to the per-agent user guides in the Agent Registry Overview — for example the Well Recompletions Agent or the ecosystem agent guides (OSDU, Databricks, Snowflake, Tavily, and more).

Documentation index

The complete set of guides, grouped by the component they cover.

Backend services

The server-side orchestrator and its companion services. Located in Spotfire Copilot Backend Services/.

  • Installation Guide — Backend Setup — Deploy the orchestrator: generate credentials, choose an LLM provider, configure the knowledge base, and deploy with Docker across Azure, GCP, AWS, or Kubernetes, followed by verification and post-deployment setup. Applies to: Orchestrator Service (versions 2.3.0–2.3.5).
  • Admin Console Guide — Day-to-day operation of the admin console for customer administrators: managing users, OAuth2 clients, conversations, RAG indexes, and system health. Applies to: Admin Console (versions 2.3.0–2.3.4).
  • Data Loaders Installation Guide — Install and configure the data-loader services that ingest documents into the knowledge base: image selection, LLM and embedding providers, supported vector databases, and document preparation. Applies to: Data Loader Services (versions 2.3.0–2.3.4).

Client extension

The Copilot panel that runs inside Spotfire clients. Located in Spotfire Copilot Client Extension/.

  • Installation Guide — Frontend Setup — Deploy and configure the Copilot client panel: package deployment, Copilot preferences, licensing, enabling the panel in Spotfire Analyst and Web Player, and first usage. Applies to: Spotfire Copilot version 2.3.x.

Agent Registry

External agents are one of the most powerful ways to extend Spotfire Copilot. The Agent Registry lets you host and build custom A2A (Agent-to-Agent) agents — from narrowly use-case-targeted agents to general-purpose ones — that plug into the orchestrator and dramatically broaden what Copilot can do for your users.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages