google-search-console-mcp-server: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Documentation Structure

IMPORTANT: Always refer to these documentation files for context and guidance:

• docs/PROJECT_STATUS.md - Current implementation status, completed/pending features, next steps
• docs/TASKS.md - Detailed task checklist for all implementation phases (use this for tracking progress)
• docs/DEVELOPMENT.md - Development setup, coding standards, testing procedures, troubleshooting
• docs/API.md - Complete API reference for all MCP tools with examples
• docs/requirement.md - Original requirements specification (Japanese)

Before starting any work, check docs/PROJECT_STATUS.md and docs/TASKS.md to understand current progress.

Project Overview

Google Search Console MCP Server - A Model Context Protocol server that provides programmatic access to Google Search Console API data through Claude Code and Cursor.

Language: TypeScript Runtime: Node.js v18+ Package Type: ESM (type: "module")

Build & Development Commands

# Build the project
npm run build

# Watch mode for development
npm run dev

# Initial authentication setup
npm run setup-auth

# Prepare for publishing (runs build)
npm run prepare

Project Architecture

Directory Structure

src/
├── index.ts                 # Main MCP server entry point
├── auth/
│   ├── google-auth.ts       # Google OAuth 2.0 authentication client
│   └── setup-auth.ts        # CLI tool for initial authentication
├── tools/
│   ├── list-sites.ts        # MCP tool: List accessible Search Console sites
│   ├── get-analytics.ts     # MCP tool: Query search performance data
│   ├── get-sitemaps.ts      # MCP tool: Retrieve sitemap information
│   └── inspect-url.ts       # MCP tool: Inspect URL indexing status
└── types/
    └── index.ts             # TypeScript type definitions
build/                       # Compiled output (gitignored)