Skip to main content
Glama

export_session

Export a session's complete structure, version history, and metadata as a portable JSON bundle for migration or archival, with optional embedded knowledge structures.

Instructions

Export a full session bundle for migration or archival. Unlike export_knowledge (which converts to RDF/JSON-LD), this tool packages the session's current structure, version history, and metadata into a self-contained JSON document that can be used to recreate the session in another runtime instance. Supports two formats: 'bundle' (default) — a complete migration envelope with version history; 'cks' — bare canonical CKS JSON of the current structure only. Set 'include_structures' to true to embed the full KnowledgeStructure for each historical version (may be large).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoOutput format: 'bundle' (default) — full migration envelope with metadata and version history; 'cks' — current structure only.
session_idYesThe session to export.
include_structuresNoOptional. When true and format='bundle', embed the serialized KnowledgeStructure for each version in the history (may produce a large payload for long-lived sessions). Default false.
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description discloses the output nature (self-contained JSON document), what it includes (version history, metadata), and warns about potentially large payloads when include_structures is set. Since no annotations are provided, this added context is valuable, though it stops short of explicitly stating side effects or required permissions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-organized: a clear purpose statement, a sibling contrast, format details, and a note on the include_structures option. It is reasonably concise for a tool with three parameters, though a minor redundancy with the schema could be tightened.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the absence of an output schema and annotations, the description provides a solid overview of what the tool returns (self-contained JSON, version history, metadata) and includes a size warning. It covers the essential context, though a brief note on non-destructive behavior would have made it fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

All parameters are described in the schema (100% coverage), giving a baseline of 3. The description adds extra meaning by elaborating on the difference between 'bundle' and 'cks' formats and the implications of include_structures, going beyond the schema's bare definitions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool exports a full session bundle for migration or archival. It explicitly differentiates from export_knowledge, eliminating ambiguity and making the purpose and scope immediately clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly contrasts with export_knowledge, telling the user when not to use this tool (when RDF/JSON-LD output is desired). It also explains the two output formats and when to prefer each, providing direct guidance on usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Deus-corp/cks-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server