Skip to main content
Glama

get_sheet_info

Retrieve spreadsheet metadata including sheet names, properties, and basic structure to understand document organization and contents.

Instructions

スプレッドシートの基本情報を取得します

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
spreadsheetIdYesスプレッドシートのID

Implementation Reference

  • The main handler function that implements the get_sheet_info tool logic. It uses the Google Sheets API to fetch the spreadsheet metadata, extracts sheet information, and returns it as JSON.
    async function getSheetInfo(spreadsheetId: string) {
      const authClient = await auth.getClient();
      const sheets = google.sheets({ version: "v4", auth: authClient as any });
    
      const response = await sheets.spreadsheets.get({
        spreadsheetId,
      });
    
      const sheetsInfo = response.data.sheets?.map((sheet) => ({
        title: sheet.properties?.title,
        sheetId: sheet.properties?.sheetId,
        rowCount: sheet.properties?.gridProperties?.rowCount,
        columnCount: sheet.properties?.gridProperties?.columnCount,
      }));
    
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(
              {
                title: response.data.properties?.title,
                sheets: sheetsInfo,
              },
              null,
              2
            ),
          },
        ],
      };
    }
  • Input schema definition for the get_sheet_info tool, specifying the required spreadsheetId parameter.
    inputSchema: {
      type: "object",
      properties: {
        spreadsheetId: {
          type: "string",
          description: "スプレッドシートのID",
        },
      },
      required: ["spreadsheetId"],
    },
  • src/index.ts:109-122 (registration)
    Registration of the get_sheet_info tool in the tools array used for ListToolsRequestHandler.
    {
      name: "get_sheet_info",
      description: "スプレッドシートの基本情報を取得します",
      inputSchema: {
        type: "object",
        properties: {
          spreadsheetId: {
            type: "string",
            description: "スプレッドシートのID",
          },
        },
        required: ["spreadsheetId"],
      },
    },
  • src/index.ts:177-178 (registration)
    Tool dispatch case in the CallToolRequestHandler that invokes the getSheetInfo handler.
    case "get_sheet_info":
      return await getSheetInfo(args.spreadsheetId as string);
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 only states the action ('取得します') without detailing traits such as whether this is a read-only operation, potential rate limits, authentication needs, or what '基本情報' (basic information) entails in terms of return format or scope. This leaves significant gaps for a tool with no annotation coverage.

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 in Japanese that directly states the purpose without any wasted words. It's appropriately sized and front-loaded, making it easy to parse quickly.

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 what '基本情報' includes (e.g., metadata, properties), behavioral aspects like error handling, or how it differs from siblings. For a tool with no structured data beyond the input schema, more context is needed to be fully helpful.

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 the single required parameter 'spreadsheetId'. The description adds no additional meaning beyond this, as it doesn't elaborate on parameter usage or constraints. According to the rules, with high schema coverage, the baseline is 3 even without param info in the description.

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 action ('取得します' - get/retrieve) and resource ('スプレッドシートの基本情報' - basic information of a spreadsheet), providing a specific purpose. However, it doesn't explicitly differentiate from sibling tools like 'read_sheet', which might have overlapping functionality, preventing 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 'read_sheet' or other siblings. There's no mention of prerequisites, context, or exclusions, leaving the agent with minimal usage direction beyond the basic purpose.

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/Kyohei-9841/google-spreadsheet-MCP'

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