Skip to main content

AI capabilities overview

ApiGo organizes its AI capabilities into four main areas: AI data query (natural-language data lookup), AI assistant (multi-turn conversation with operation confirmation), MCP access (letting external agents call platform capabilities) and AI call logs (auditing and success rates). This page explains how they relate; see the dedicated pages for detailed procedures.

Capability map​

CapabilityAudienceDetails
AI data queryPlatform usersAI data query and SQL analysis
AI assistant chatPlatform usersThe "AI assistant" section of this page
App MCPExternal AI clientsMCP access
Admin MCP / agentsAI agents managing the platformMCP agents
Call logs and success ratesAdministratorsAI call logs

AI data query​

Describe your data needs in natural language, and the system combines the semantic layer to generate SQL, execute the query and render charts:

  1. Select a project and data source, then enter a business question.
  2. The orchestrator parses the intent and matches the scenario plus semantic terms/metrics.
  3. SQL is generated and executed after read-only validation.
  4. Results are returned as tables or charts, and you can keep asking follow-up questions.

AI data query only allows read-only queries. Write operations, DDL and multiple statements are blocked; when SQL generation fails, the system attempts automatic repair, and if that still fails, it returns a readable error explanation. See AI data query and SQL analysis for the full flow and limitations.

AI assistant​

The AI assistant is the conversational entry point in the platform. It uses SSE streaming responses and supports multi-turn context. Unlike ordinary Q&A, it can:

  • Call platform tools to query resources such as APIs, data sources and logs;
  • Generate a confirmation card when a write or high-risk operation is required, and execute only after the user confirms;
  • Display the execution trace, including each tool call, SQL, latency and result summary;
  • Route to different capability sets by scenario, such as data query, operations and API development scenarios.

Session state is stored in base_ai_agent_session_state, so a pending confirmation flow can continue after the page is refreshed or the reply is spread across multiple turns.

MCP access​

The platform provides two MCP services, both using JSON-RPC 2.0 / MCP 2025-06-18:

EntryAddressAuthenticationTool source
App MCP/mcp/{appCode}X-AppKeyAPIs that are published, use app_key authentication and include MCP in their release protocol
Admin MCP/api/box/mcp/{agentCode}X-Agent-KeyThe admin tool set (querying and managing platform resources)

Tool mapping rules​

For an API to be visible to external MCP clients, all of the following must be satisfied:

  1. The release protocol includes MCP;
  2. The API is released to the prod environment and is live;
  3. The authentication method is app_key;
  4. The calling credential has been granted access to the API;
  5. The app has mcpEnabled = 1.

The tool name is taken from the API definition's toolName first; when empty, skillCode is used, and when that is also empty, the name is generated from the path. The tool description comes from the API documentation and parameter definitions.

Supported methods​

MethodHandled byDescription
initializeGatewayReturns the protocol version and server capabilities
notifications/initializedGatewayClient initialization complete notification, with no response
tools/listGatewayReturns the tool list available to the current credential
tools/callExecution chainConverted into a REST runtime call, passing through authentication, rate limiting, IP, caching and logging

MCP only accepts POST; GET returns 405. See MCP access for details.

Controlled access model​

AI is not a bypass around governance; all capabilities go through the same boundaries:

  • Data isolation: sessions, the semantic layer and data sources are all bound to projects and are not visible across projects.
  • Read-only first: data query only executes queries; write operations require explicit confirmation or dedicated tool permissions.
  • Tool whitelist: agents can call only the tools bound to them, and read and write tools are authorized separately.
  • Full auditing: every question, tool call and SQL execution is written to the AI audit log, including latency, tokens and success status.
  • Traceable failures: failure reasons are grouped by scenario, and the success-rate report aggregates by scenario and failure reason.