Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

5.2 KB
Raw Blame
import { Schema } from 'mongoose';
import { SkillsScope } from 'librechat-data-provider';
import type { IAgent } from '~/types';

const agentSchema: Schema<IAgent> = new Schema<IAgent>(
  {
    id: {
      type: String,
      required: true,
    },
    name: {
      type: String,
    },
    description: {
      type: String,
    },
    instructions: {
      type: String,
    },
    avatar: {
      type: Schema.Types.Mixed,
      default: undefined,
    },
    provider: {
      type: String,
      required: true,
    },
    model: {
      type: String,
      required: true,
    },
    model_parameters: {
      type: Object,
    },
    artifacts: {
      type: String,
    },
    access_level: {
      type: Number,
    },
    recursion_limit: {
      type: Number,
    },
    tools: {
      type: [String],
      default: undefined,
    },
    skills: {
      type: [String],
      default: undefined,
    },
    skills_enabled: {
      type: Boolean,
      default: undefined,
    },
    skill_authoring_enabled: {
      type: Boolean,
      default: undefined,
    },
    skills_scope: {
      type: String,
      enum: Object.values(SkillsScope),
      default: undefined,
    },
    tool_kwargs: {
      type: [{ type: Schema.Types.Mixed }],
    },
    actions: {
      type: [String],
      default: undefined,
    },
    author: {
      type: Schema.Types.ObjectId,
      ref: 'User',
      required: true,
    },
    authorName: {
      type: String,
      default: undefined,
    },
    hide_sequential_outputs: {
      type: Boolean,
    },
    end_after_tools: {
      type: Boolean,
    },
    stateful_code_sessions: {
      type: Boolean,
    },
    stateful_code_environment: {
      type: String,
      enum: ['user', 'agent-user', 'conversation'],
    },
    code_environment_id: {
      type: String,
    },
    code_workspace_id: { type: String },
    code_environment_ids: { type: [String], default: undefined },
    repositoryInstructions: { type: String, enum: ['prefer', 'defer', 'off'] },
    instructionsPrompt: {
      type: new Schema(
        {
          source: { type: String, enum: ['native', 'langfuse'], required: true },
          groupId: { type: String, required: true },
          selection: {
            type: new Schema(
              {
                type: { type: String, enum: ['production', 'exact'], required: true },
                promptId: { type: String },
                version: { type: Number },
              },
              { _id: false },
            ),
            required: true,
          },
        },
        { _id: false },
      ),
      default: undefined,
    },
    git_identity: {
      type: new Schema(
        {
          name: { type: String, required: true },
          email: { type: String, required: true },
        },
        { _id: false },
      ),
      default: undefined,
    },
    /** @deprecated Use edges instead */
    agent_ids: {
      type: [String],
    },
    edges: {
      type: [{ type: Schema.Types.Mixed }],
      default: [],
    },
    conversation_starters: {
      type: [String],
      default: [],
    },
    tool_resources: {
      type: Schema.Types.Mixed,
      default: {},
    },
    versions: {
      type: [Schema.Types.Mixed],
      default: [],
    },
    category: {
      type: String,
      trim: true,
      index: true,
      default: 'general',
    },
    support_contact: {
      type: Schema.Types.Mixed,
      default: undefined,
    },
    is_promoted: {
      type: Boolean,
      default: false,
      index: true,
    },
    /** MCP server names extracted from tools for efficient querying */
    mcpServerNames: {
      type: [String],
      default: [],
    },
    /** Per-tool configuration (defer_loading, allowed_callers, run_in_background, describe_intent) */
    tool_options: {
      type: Schema.Types.Mixed,
      default: undefined,
    },
    /** Subagent spawning configuration — isolated-context child agents. */
    subagents: {
      type: Schema.Types.Mixed,
      default: undefined,
    },
    /** Memory partition: 'agent' isolates memories per (user, agent); default shared pool */
    memory_scope: {
      type: String,
      enum: ['user', 'agent'],
      default: undefined,
    },
    tenantId: {
      type: String,
      index: true,
    },
  },
  {
    timestamps: true,
  },
);

agentSchema.index({ id: 1, tenantId: 1 }, { unique: true });
agentSchema.index({ mcpServerNames: 1, tenantId: 1 });
agentSchema.index({ updatedAt: -1, _id: 1 });
agentSchema.index({ tenantId: 1, updatedAt: -1, _id: 1 });
// Supports newest and oldest scans; oldest reverses the complete key pattern.
agentSchema.index({ createdAt: -1, _id: 1 });
agentSchema.index({ tenantId: 1, createdAt: -1, _id: 1 });
agentSchema.index({ 'edges.to': 1 });
/** Reference checks before code environment removal match either field; each `$or` branch needs its own index. */
agentSchema.index(
  { code_environment_id: 1 },
  {
    name: 'agent_code_environment_id',
    partialFilterExpression: { code_environment_id: { $exists: true } },
  },
);
agentSchema.index(
  { code_environment_ids: 1 },
  {
    name: 'agent_code_environment_ids',
    partialFilterExpression: { code_environment_ids: { $exists: true } },
  },
);

export default agentSchema;