MCP Gsc

🚀 Google Search Console Tool Usage Guide

This guide provides a comprehensive overview of how to install, configure, and use the Google Search Console tool, along with troubleshooting tips and contribution guidelines.

🚀 Quick Start

📦 Installation

To start using the Google Search Console tool, follow these installation steps:

1. Download and Install Node.js Ensure you have the latest version of Node.js and npm (Node Package Manager) installed. You can download them from the Node.js official website.

2. Install Dependencies Open a terminal, navigate to the project directory, and run the following command to install the required dependencies:

   npm install
   

3. Configure Environment Variables Create a .env file and add the following content:

   GOOGLE_API_KEY=your_api_key_here
   PROPERTY_ID=your_property_id_here
   

4. Start the Application Run the following command in the terminal:

   npm start
   

⚙️ Configuration

Server Configuration

• Specify a Port To run the server on a specific port, you can specify it in the command line:

  npm start -- --port 3001
  

• Set the Environment Mode Choose the development, test, or production environment as needed:

  npm run dev
  npm run test
  npm run prod
  

Database Configuration

Add the following content to the .env file to configure the database:

DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=secret
DB_NAME=gsc_data

💻 Usage Examples

Common Commands

• Get a Summary Report To get a performance summary of your site, run the following command:

  npm run report -- --type summary
  

• Monitor Crawler Activity Start crawler monitoring:

  npm run crawler
  

Detailed Usage

Generate a Report

To generate a detailed performance report, follow these steps:

1. Run the Report Generator Enter the following command in the terminal:

   npm run report -- --type detailed
   

2. Specify the Output Path If you need to save the report to a specific directory, you can add the --output option:

   npm run report -- --type detailed --output ./reports/
   

Monitoring Function

• Real-time Monitoring Start the real-time monitoring service to track site performance:

  npm run monitor
  

🔧 Troubleshooting

Error Code Explanation

1. Error Code: 401 Unauthorized Your API key may be invalid or have insufficient permissions. Please check your key settings.

2. Error Code: 500 Internal Server Error There is an internal server error, which may be caused by missing dependencies or configuration issues.

Troubleshooting Steps

• Verify the API Key Ensure that the API key you are using has the correct permissions and that the Search Console API is enabled in the Google Cloud Platform.

• Check the Log Files View the server.log file to get more detailed error information:

  tail -f logs/server.log
  

Frequently Asked Questions

1. Unable to Connect to the Database Check if the database is running and ensure that the DB_HOST and DB_PORT configurations are correct.

2. API Request Failed Confirm that your API key has the correct permission scope settings in the Google Cloud Platform.

🤝 Contribution Guidelines

Submit an Issue or Suggestion

1. Report an Issue Open a new issue on GitHub and provide the following information:

   • Error description
   • Steps to reproduce
   • System environment

2. Submit a Patch Fork the repository, create a feature branch, and submit a Pull Request.

📄 License

This project is licensed under the MIT License.

💻 Code Example

const express = require('express');
const app = express();

// Configure middleware
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// Define routes
app.get('/api/data', (req, res) => {
    // Get data and return a response
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
    console.log(`Server running on port ${PORT}`);
});

👥 Contributors

• John Doe
• Jane Smith