Retrieve detailed information about a FaceSign session including status, transcript, AI analysis, node reports, video AI analysis, and asynchronous analysis lifecycle states.
| Name | Required | Description | Default |
|---|---|---|---|
| sessionId | Yes | The session ID to retrieve |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description carries the full burden. It clearly communicates a read operation by using 'Retrieve' and lists the content categories returned. However, it does not disclose error behavior, permissions, rate limits, or the meaning of 'asynchronous analysis lifecycle states,' leaving some behavioral traits unexplained.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that front-loads the action and resource, then enumerates the included data types without redundancy. Every phrase adds useful information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read tool with no output schema, the description provides a strong sense of the return content by listing major components (transcript, AI analysis, node reports, etc.). It is not exhaustive but gives an appropriate high-level overview. Slight ambiguity remains around the 'asynchronous analysis lifecycle states' but the tool is still usable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with 'sessionId' already described as 'The session ID to retrieve'. The description adds no further parameter-specific meaning, so it does not exceed the schema baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb 'Retrieve' with a clear resource 'FaceSign session' and enumerates the exact scope of information returned. This clearly distinguishes it from siblings like list_sessions (which lists sessions) and launch_session_ui (which launches UI).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The context implies use when a specific session's detailed info is needed, especially after listing sessions. However, it does not explicitly state when to use this tool vs alternatives, nor does it mention exclusions or prerequisites. Sibling tools provide contrast but the description itself offers no guidance on selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool targets a distinct action: setting the API key, launching the UI, retrieving session details, listing sessions, and exporting as an app. Even though launch_session_ui and export_app both require HTML/UI string parameters, their purposes (local run vs. deployable export) are clearly different.
All tool names follow a consistent verb_noun pattern in snake_case: set_api_key, launch_session_ui, get_session, list_sessions, export_app. The verbs are clear and the nouns are the corresponding resource, making the pattern predictable.
With 5 tools, the set is well-scoped and each tool directly supports the server's purpose of managing FaceSign sessions. This is comfortably within the ideal 3-15 range and avoids unnecessary bloat.
The tool surface covers the core workflow: setting the API key, launching a session UI, retrieving session data, listing sessions, and exporting a standalone app. A minor gap is the lack of explicit session cancellation or deletion, but this appears manageable since sessions are ephemeral per launch and status can be filtered.
