Skip to main content
Glama

getCardsByArea

Retrieve cards within a specific area on a Heptabase whiteboard using coordinates and radius for focused data analysis and organization.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
radiusNo
whiteboardIdYes
xYes
yYes

Implementation Reference

  • The main tool handler function that fetches cards by area using the data service, formats a text response listing the cards and their positions, and returns it in the expected MCP content format.
    handler: async (params) => {
      await this.ensureDataServiceInitialized();
    
      const radius = params.radius || 100;
      const cards = await this.dataService!.getCardsByArea(
        params.whiteboardId,
        params.x,
        params.y,
        radius
      );
      
      let text = `Found ${cards.length} cards within radius ${radius} of (${params.x}, ${params.y})\n`;
      
      for (const card of cards) {
        text += `\n- ${card.title || 'Untitled'} (ID: ${card.id})\n`;
        
        // Get instance info to show position
        const result = await this.dataService!.getCard(card.id);
        const instance = result.instances.find(i => i.whiteboardId === params.whiteboardId);
        if (instance) {
          text += `  Position: (${instance.x}, ${instance.y})\n`;
        }
      }
    
      return {
        content: [{
          type: 'text',
          text
        }]
      };
    }
  • Zod schema defining the input parameters for the getCardsByArea tool: whiteboardId (string), x/y (numbers), optional radius (number).
    const getCardsByAreaSchema = z.object({
      whiteboardId: z.string(),
      x: z.number(),
      y: z.number(),
      radius: z.number().optional()
    });
  • src/server.ts:661-663 (registration)
    Registration of the 'getCardsByArea' tool with the MCP server, using the schema and delegating to the predefined handler.
    this.server.tool('getCardsByArea', getCardsByAreaSchema.shape, async (params) => {
      return this.tools.getCardsByArea.handler(params);
    });
  • Helper method in HeptabaseDataService that computes cards within a given radius on a whiteboard by filtering card instances based on Euclidean distance.
    async getCardsByArea(
      whiteboardId: string,
      x: number,
      y: number,
      radius: number
    ): Promise<Card[]> {
      const instances = Object.values(this.data.cardInstances).filter(instance => {
        if (instance.whiteboardId !== whiteboardId) return false;
        
        const distance = Math.sqrt(
          Math.pow(instance.x - x, 2) + Math.pow(instance.y - y, 2)
        );
        
        return distance <= radius;
      });
    
      const cardIds = instances.map(instance => instance.cardId);
      return cardIds.map(id => this.data.cards[id]).filter(Boolean);
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

Related 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/LarryStanley/heptabse-mcp'

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