Ciele

Server MCP di Ciele

Concedi a un client MCP l'accesso controllato alle operazioni di amministrazione di Ciele.

Il server Ciele Model Context Protocol (MCP) espone le operazioni di amministrazione a un agente IA. Dispone di due transport, ed entrambi registrano gli stessi tool.

  • L'hosted endpoint è POST /api/mcp sulla tua distribuzione. Usalo per un client che si connette tramite HTTP.
  • Il local server è un processo stdio che avvii da un checkout del repository.

Ogni chiamata a uno strumento raggiunge l'Organization tramite /api/v1, quindi un'operazione ha un unico percorso di esecuzione, indipendentemente dal trasporto che l'ha richiesta.

Endpoint ospitato

Ogni deployment di Ciele espone l'endpoint dal proprio origin. Ciò include il servizio ospitato, un self-host Docker e lo stack locale di Ciele Desktop. L'endpoint non richiede alcuna configurazione.

https://ciele.example.edu/api/mcp

Esegui l'autenticazione con una Organization API key nell'header Authorization:

Authorization: Bearer ciele_sk_...

Una chiave sconosciuta o assente viene rifiutata con 401 prima che venga elencato qualsiasi tool.

The key Role is the permission boundary

The permissions of the hosted endpoint are the Role of the key. The operations layer refuses a mutation that the Role does not cover with 403. A Viewer key is not a read-only agent, though. Reviewing conversations counts as curation, so a Viewer key can pin a conversation, leave feedback, and delete a conversation.

A self-hosted deployment can set CIELE_MCP_READ_ONLY=1 on the application. Then the hosted endpoint refuses every mutation action for every key. For one read-only agent on a shared deployment, use CIELE_MCP_READ_ONLY=1 on a stdio server.

Revisioni del protocollo

Il server supporta la revisione 2026-07-28 e le revisioni 2025. Determina la revisione fin dallo scambio iniziale, perciò un client che non è passato a 2026-07-28 continua a funzionare.

La revisione 2026-07-28 ha rimosso le sessioni di protocollo. Ogni richiesta è indipendente, quindi l'endpoint ospitato non necessita di sticky routing né di un session store.

Server stdio locale

Requisiti

  • Utilizza Node.js 22.6 o versioni successive.
  • Clona il repository di Ciele.
  • Crea una Organization API key.
  • Utilizza un client MCP in grado di avviare un server stdio locale.

Avvia questo programma dal repository:

node <repo>/packages/mcp/bin/ciele-mcp.mjs

Variabili di ambiente

VariableRequirementPurpose
CIELE_API_KEYObbligatoriaAutentica l'organizzazione.
CIELE_BASE_URLOptionalSeleziona un'origine self-hosted.
CIELE_MCP_READ_ONLYOptionalRifiuta le azioni di mutazione quando il valore è 1.
CIELE_MCP_MODERN_ONLYOptionalRifiuta i client della revisione 2025 quando il valore è 1.

Il controllo di sola lettura avviene all'interno del processo MCP. Una mutazione rifiutata non effettua una richiesta API.

These variables on a deployment

A Ciele web container obeys CIELE_MCP_READ_ONLY. Then the hosted endpoint refuses mutation actions for every key. The container ignores CIELE_MCP_MODERN_ONLY, and the hosted endpoint always accepts 2025-revision clients.

Recommended first connection

Use a viewer key and set CIELE_MCP_READ_ONLY=1. Remove one restriction only when the agent must change Ciele data.

Strumenti disponibili

ToolOperazioni correnti
ciele_identityLeggi le informazioni su deployment, Organization e Role.
manage_assistantsPoni una domanda a un Assistente, quindi elenca, leggi, crea, aggiorna, duplica o elimina gli Assistenti.
manage_flowsLeggi il catalogo dei Flow, verifica un Flow senza salvarlo, leggi le esecuzioni di un HTTP Flow, quindi elenca, leggi, crea, aggiorna, riordina o elimina i Flow.
manage_knowledgeCerca nella knowledge base, quindi gestisci Collections, Sources e FAQ.
publish_assistantLeggi lo stato, pubblica, annulla la pubblicazione o ripristina una pubblicazione.
read_inboxElenca, leggi, esporta, appunta, annota, valuta o elimina le Conversations. Elenca, leggi e decidi le richieste di revisione umana.
manage_improvementsElenca, leggi o aggiorna gli Improvements.
manage_memoriesVerifica le impostazioni ed esegui la cancellazione della memoria con ambito definito.
manage_ssoGestisci le identity claim e la connessione SSO dell'organizzazione.
manage_help_desksGestisci Help Desk, canali, ordinamento e ticketing target.
manage_teammatesGestisci gli AI Teammate, i loro grant, le loro Routine e la loro memoria. provision esegue la configurazione completa con una sola azione.
manage_projectsGestisci i Projects, i loro milestones e il memory document di ciascun Project.
manage_tasksElenca, leggi, crea, modifica ed elimina le attività. Commenta le attività e gestisci le etichette delle attività.
manage_channelsLeggi e modella i canali dei teammate in cui sei presente.
manage_configurationGestisci Skills, la selezione delle Assistant Skills, Goals, Alerts e Quick Texts.
manage_organizationGestisci le impostazioni dell'organizzazione, i Members, i Roles e le relative funzionalità, gli Invites e le API keys. Consulta i misuratori di utilizzo e i responsabili della spesa del piano, nonché l'audit log.
manage_integrationsGestisci le integrazioni API dell'Assistente e i provider di modelli.

Il server registra diciassette strumenti: uno strumento di identità e sedici strumenti di dominio. Ogni strumento di dominio utilizza un campo action per le proprie operazioni.

La modalità di sola lettura classifica ogni azione. Consente le azioni list, read, status, query, search ed export, mentre rifiuta le mutation.

Cerca nella knowledge base

L'azione search di manage_knowledge trova i passaggi che corrispondono a una domanda. Ogni risultato riporta il testo del passaggio, il titolo del Documento, il nome della Source e, se presente, l'URL. Ciele non genera una risposta. Il tuo client di IA scrive la risposta e cita le Sources.

{ "action": "search", "query": "How do I connect Salesforce?", "assistantId": "<assistant-id>" }

Con assistantId, la ricerca utilizza solo le Sources collegate a quell'Assistant. Senza di esso, la ricerca utilizza l'intera Library dell'Organization. Una chiave viewer può eseguire ricerche e la modalità di sola lettura lo consente. Una ricerca non crea una Conversation, quindi non compare né nell'Inbox né in Insights. Ogni chiave API può eseguire 60 ricerche in un minuto.

Chiedi a un Assistente

L'azione ask di manage_assistants invia una domanda a un Assistente e restituisce la sua risposta insieme alle Sources che ha citato. Usalo quando il client deve mostrare la risposta di Ciele, non la propria risposta.

{ "action": "ask", "id": "<assistant-id>", "question": "How do I connect Salesforce?" }

L'Assistente risponde come fa il suo widget pubblicato, utilizzando i suoi Flows e la sua ricerca nella knowledge base. Se l'Assistant non è pubblicato, l'azione non va a buon fine. Invia il conversationId di una risposta insieme alla domanda successiva per proseguire la stessa Conversation. Solo l'API key che ha avviato una Conversation può proseguirla. Con un ID diverso, la domanda avvia una nuova Conversation.

Ogni domanda crea una Conversation. Insights non lo conteggia. L'Inbox lo mostra con l'etichetta API key quando imposti il filtro Staff conversations su Include staff o Staff only. La domanda utilizza un turno del modello sulle Provider Connections dell'Organization. Per questo motivo, la modalità di sola lettura rifiuta ask. Ogni chiave API può porre 20 domande in un minuto. Una risposta può richiedere un po' di tempo, perché l'Assistente può eseguire la ricerca più di una volta.

Consulta AI clients per la configurazione di ciascun client supportato.

Verifica la connessione

Chiedi al client di chiamare ciele_identity. Conferma l'Organization ID, il Role, la versione dell'API e l'elenco dei domini previsti.

La suite di test del repository avvia anche il processo stdio reale. Verifica l'inizializzazione, il rilevamento degli strumenti e una chiamata API autenticata.

In questa pagina