Skip to main content
Glama

kb_list_forms

List available forms and their structures to access stored knowledge categories and data formats in the MCP Instruct server.

Instructions

List available forms and their structures

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNoall

Implementation Reference

  • The main handler logic for executing the kb_list_forms tool. It extracts the 'type' parameter and returns the appropriate forms (onboarding, quick, or both) as JSON.
    case 'kb_list_forms': {
      const type = (args as any).type || 'all';
      let forms: any = {};
      
      if (type === 'onboarding' || type === 'all') {
        forms.onboarding = onboardingForms;
      }
      if (type === 'quick' || type === 'all') {
        forms.quick = quickForms;
      }
    
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(forms, null, 2)
          }
        ]
      };
    }
  • src/index.ts:324-337 (registration)
    Registration of the kb_list_forms tool in the MCP tools list, including its description and input schema.
    {
      name: 'kb_list_forms',
      description: 'List available forms and their structures',
      inputSchema: {
        type: 'object',
        properties: {
          type: {
            type: 'string',
            enum: ['onboarding', 'quick', 'all'],
            default: 'all'
          }
        }
      }
    },
  • Definition of onboardingForms, which contains structured question data for onboarding categories. Used by kb_list_forms.
    export const onboardingForms: Record<string, OnboardingQuestion[]> = {
      initial: [
        {
          id: 'personal_name',
          question: 'What is your full name?',
          category: 'personal',
          field: 'name',
          type: 'text',
          required: true
        },
        {
          id: 'personal_birth_year',
          question: 'What year were you born?',
          category: 'personal',
          field: 'birthYear',
          type: 'number',
          required: false
        },
        {
          id: 'personal_location',
          question: 'Where are you currently located? (City, Country)',
          category: 'personal',
          field: 'currentLocation',
          type: 'text',
          required: false
        },
        {
          id: 'personal_languages',
          question: 'What languages do you speak? (comma-separated)',
          category: 'personal',
          field: 'languages',
          type: 'multiselect',
          required: false
        },
        {
          id: 'personal_pronouns',
          question: 'What are your pronouns?',
          category: 'personal',
          field: 'pronouns',
          type: 'text',
          required: false
        }
      ],
      professional: [
        {
          id: 'prof_occupation',
          question: 'What is your occupation/job title?',
          category: 'professional',
          field: 'occupation',
          type: 'text',
          required: true
        },
        {
          id: 'prof_experience',
          question: 'How many years of experience do you have?',
          category: 'professional',
          field: 'yearsOfExperience',
          type: 'number',
          required: false
        },
        {
          id: 'prof_industry',
          question: 'What industry do you work in?',
          category: 'professional',
          field: 'industry',
          type: 'text',
          required: false
        },
        {
          id: 'prof_specializations',
          question: 'What are your specializations? (comma-separated)',
          category: 'professional',
          field: 'specializations',
          type: 'multiselect',
          required: false
        },
        {
          id: 'prof_skills',
          question: 'What are your main technical skills? (comma-separated)',
          category: 'professional',
          field: 'skills',
          type: 'multiselect',
          required: false
        }
      ],
      preferences: [
        {
          id: 'pref_communication',
          question: 'How do you prefer communication? (formal/casual/technical)',
          category: 'preferences',
          field: 'communicationStyle',
          type: 'select',
          options: ['formal', 'casual', 'technical', 'balanced'],
          required: false
        },
        {
          id: 'pref_detail',
          question: 'How detailed should responses be?',
          category: 'preferences',
          field: 'responseDetail',
          type: 'select',
          options: ['concise', 'detailed', 'balanced'],
          required: false
        },
        {
          id: 'pref_technical',
          question: 'What is your technical expertise level?',
          category: 'preferences',
          field: 'technicalLevel',
          type: 'select',
          options: ['beginner', 'intermediate', 'expert'],
          required: false
        }
      ],
      projects: [
        {
          id: 'proj_current',
          question: 'What projects are you currently working on? (comma-separated)',
          category: 'projects',
          field: 'currentProjects',
          type: 'multiselect',
          required: false
        },
        {
          id: 'proj_tech',
          question: 'What technologies are you using? (comma-separated)',
          category: 'projects',
          field: 'technologies',
          type: 'multiselect',
          required: false
        },
        {
          id: 'proj_goals',
          question: 'What are your current goals? (comma-separated)',
          category: 'projects',
          field: 'goals',
          type: 'multiselect',
          required: false
        }
      ]
    };
  • Definition of quickForms, which contains field structures for quick setup forms. Used by kb_list_forms.
    export const quickForms: Record<string, any> = {
      identity: {
        title: "Quick Identity Setup",
        fields: {
          name: { type: 'text', label: 'Full Name', required: true },
          occupation: { type: 'text', label: 'Job Title', required: true },
          location: { type: 'text', label: 'Location', required: false },
          languages: { type: 'array', label: 'Languages', required: false }
        }
      },
      technical: {
        title: "Technical Profile",
        fields: {
          role: { type: 'text', label: 'Role', required: true },
          experience: { type: 'number', label: 'Years of Experience', required: true },
          skills: { type: 'array', label: 'Skills', required: true },
          tools: { type: 'array', label: 'Favorite Tools', required: false }
        }
      },
      organization: {
        title: "Organization Setup",
        fields: {
          orgName: { type: 'text', label: 'Organization Name', required: true },
          industry: { type: 'text', label: 'Industry', required: true },
          size: { type: 'select', label: 'Company Size', options: ['1-10', '11-50', '51-200', '200+'], required: false },
          mission: { type: 'text', label: 'Mission', required: false }
        }
      }
    };
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states it's a list operation, implying read-only behavior, but doesn't mention any constraints like pagination, rate limits, authentication needs, or what 'structures' entails in the return. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose without unnecessary words. Every part of the sentence earns its place by clearly stating what the tool does, making it optimally concise and well-structured.

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

Completeness2/5

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

Given the lack of annotations, no output schema, and 0% schema description coverage for the parameter, the description is incomplete. It doesn't explain what 'structures' means in the output, how results are formatted, or any behavioral constraints, leaving the agent with insufficient context for effective use.

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

Parameters3/5

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

The description mentions 'forms' but doesn't explain the 'type' parameter or its enum values ('onboarding', 'quick', 'all'). With 0% schema description coverage and 1 parameter, the description adds minimal value beyond the schema. The baseline is 3 since it doesn't compensate for the coverage gap but doesn't worsen understanding either.

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

Purpose4/5

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

The description clearly states the verb ('List') and resource ('available forms and their structures'), making the purpose immediately understandable. However, it doesn't distinguish this tool from potential siblings like 'kb_get_all' or 'kb_search' that might also retrieve form information, which prevents a perfect score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'kb_get_all' or 'kb_search' from the sibling list. It also doesn't mention prerequisites, context requirements, or any 'when-not-to-use' scenarios, leaving the agent with minimal usage direction.

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/hlsitechio/mcp-instruct'

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