- Home
- MCP servers
- gmail-api
gmail-api
- python
0
GitHub Stars
python
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"rigzindorje-gmail-api": {
"command": "python",
"args": [
"mcp_server/main.py",
"stdio"
],
"env": {
"CONFIG": "A JSON string containing the configuration.",
"SECURITY": "Environment variables for security parameters (e.g., API keys).",
"CONFIG_PATH": "Path to a JSON configuration file (e.g., mcp_server/mcp_config.json)"
}
}
}
}You run an MCP (Model Context Protocol) server that exposes the Gmail API OpenAPI-backed endpoints. It enables you to query and interact with Gmail data in a context-aware way through MCP clients, using a standardized transport and configuration flow.
How to use
Start the MCP server in stdio mode to connect with an MCP client. Use an explicit configuration source if you need to tailor security or behavior, or rely on the defaults when appropriate.
How to install
Prerequisites include Python 3.9 or newer, and a working Python packaging tool.
Clone the project to your machine and navigate into the project directory.
git clone <repository-url>
cd mcp-server
Install development dependencies to enable editing and testing features.
pip install -e ".[dev]"
Alternative: use the provided utility to install editable dependencies via uv if you prefer not to use a dev container.
uv pip install --editable ".[dev]"
Run the server in stdio mode once dependencies are installed.
python mcp_server/main.py stdio
Configure runtime environment with optional values if needed. The following environment variables are recognized during startup:
-
CONFIG_PATH: Path to a JSON configuration file (for example, mcp_server/mcp_config.json)
-
CONFIG: A JSON string containing the configuration.
-
SECURITY: Environment variables that define security parameters (for example, API keys).
Additional sections
Configuration notes: The server can read configuration from a file or inline JSON. Ensure the path or JSON string is valid and contains the necessary fields for MCP operation.
Security considerations: Protect any API keys or tokens and apply access controls to MCP clients. If you expose a configuration with credentials, keep it secure and limit its distribution.
Testing and quality checks: Use the provided tools to lint, analyze, and test the server locally to ensure you have stable behavior in your environment.