Skip to main content
Glama

search_boards

Find boards by name or keyword within a team to quickly locate relevant project workspaces in Focalboard.

Instructions

Search for boards by name or keyword within a team.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
teamIdNoThe team ID to search within (default: "0" for default team)0
searchTermYesThe search term to find boards

Implementation Reference

  • MCP tool handler for 'search_boards': validates input parameters (teamId optional, searchTerm required), calls focalboard.searchBoards, and formats response as JSON text content.
    case 'search_boards': {
      const teamId = (args?.teamId as string) || '0';
      const searchTerm = args?.searchTerm as string;
      if (!searchTerm) {
        throw new Error('searchTerm is required');
      }
      const boards = await focalboard.searchBoards(teamId, searchTerm);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(boards, null, 2)
          }
        ]
      };
    }
  • src/index.ts:60-78 (registration)
    Registration of the 'search_boards' tool in the MCP tools array, defining name, description, and input schema for validation.
    {
      name: 'search_boards',
      description: 'Search for boards by name or keyword within a team.',
      inputSchema: {
        type: 'object',
        properties: {
          teamId: {
            type: 'string',
            description: 'The team ID to search within (default: "0" for default team)',
            default: '0'
          },
          searchTerm: {
            type: 'string',
            description: 'The search term to find boards'
          }
        },
        required: ['searchTerm']
      }
    },
  • Helper method in FocalboardClient that performs the actual API search request for boards using the makeRequest utility with query param 'q'.
    async searchBoards(teamId: string, term: string): Promise<Board[]> {
      return this.makeRequest<Board[]>(
        `/teams/${teamId}/boards/search`,
        'GET',
        undefined,
        { q: term }
      );
    }
  • JSON schema definition for 'search_boards' tool input validation, specifying teamId (optional) and required searchTerm.
    inputSchema: {
      type: 'object',
      properties: {
        teamId: {
          type: 'string',
          description: 'The team ID to search within (default: "0" for default team)',
          default: '0'
        },
        searchTerm: {
          type: 'string',
          description: 'The search term to find boards'
        }
      },
      required: ['searchTerm']
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the search functionality but doesn't cover aspects like pagination, rate limits, authentication needs, or what happens if no boards match. This leaves significant gaps in understanding the tool's behavior.

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 directly states the tool's purpose without unnecessary words. It's front-loaded and appropriately sized for a simple search tool.

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 and output schema, the description is incomplete. It doesn't explain return values, error conditions, or behavioral traits like search constraints. For a search tool with no structured context, more detail is needed to guide 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 input schema has 100% description coverage, clearly documenting both parameters. The description adds no additional parameter semantics beyond what the schema provides, such as search syntax or examples. Baseline 3 is appropriate as the schema does the heavy lifting.

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 tool's purpose as 'Search for boards by name or keyword within a team', specifying the verb (search), resource (boards), and scope (within a team). However, it doesn't explicitly differentiate from sibling tools like 'list_boards', which might serve a similar purpose without search functionality.

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. It doesn't mention sibling tools like 'list_boards' or specify scenarios where searching is preferred over listing, leaving the agent without context for tool selection.

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/gmjuhasz/focalboard-mcp-server'

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