An implementation of the Model Context Protocol (MCP) serving as a gateway to the Gmail service. This component furnishes a uniform operational layer for electronic correspondence handling, transmission, fetching, and cataloging.

Core Capabilities

• Full enumeration of Gmail API functionalities, including resource management for messages, conversation threads, organizational tags, pre-send items (drafts), and account configurations.
• Functionality to dispatch, stage, and administer electronic mail items.
• Tag administration, supporting customized visual attributes and visibility controls.
• Operations targeting conversation threads for coherent dialogue maintenance.
• Configuration oversight covering automated reply systems (vacation responder), protocol settings for IMAP/POP, and localization preferences.
• Audit trail logging for modifications within the mailbox.
• Secure authorization mechanism leveraging OAuth2 via user-provided Google Cloud credentials.

Operational Prerequisites

Required Dependencies

For the most straightforward setup, ensure Node.js version 18 or newer is installed. Local compilation efforts will additionally mandate the installation of pnpm.

Google Workspace Provisioning

Deployment of this MCP server necessitates the establishment of a Google API Client entity for your organization. Subsequent execution by each end-user requires them to obtain their unique OAuth refresh token.

Establishing the Google API Client (One-time setup per organization)

1. Navigate to the Google Cloud Console.
2. Either instantiate a fresh project or select an existing one.
3. Activate the Gmail API service within your project context.
4. Proceed to Credentials and generate an OAuth 2.0 Client ID. Designate the client type as "Desktop application."
5. Export and securely archive the resulting OAuth credentials JSON file as ~/.gmail-mcp/gcp-oauth.keys.json. ⚠️ IMPORTANT NOTE: On macOS, revealing hidden files is required to successfully create the preceding directory structure using Finder: enable hidden files guide.
6. (Optional) For deployment on remote computing infrastructure (e.g., using the Smithery CLI), document the CLIENT_ID and CLIENT_SECRET extracted from this file.

End-User Authorization Flow (One-time setup per user)

1. The user must copy the file ~/.gmail-mcp/gcp-oauth.keys.json to their local machine at the identical absolute path.
2. Execute the command: npx @shinzolabs/gmail-mcp auth.
3. A browser window will materialize, prompting the user to select an identity, review the requested permissions (scopes), and grant authorization.
4. (Optional) For remote server deployment scenarios, record the file system location reported in the completion message (default is typically ~/.gmail-mcp/credentials.json). This file contains the user's crucial REFRESH_TOKEN.

Client Integration Configuration

Various mechanisms exist for linking your MCP client application to this server instance. For centralized or remote server hosting, leverage the Smithery CLI in conjunction with a valid Smithery API Key. For direct local execution, utilize npx or compile the source code manually.

Smithery Remote Hosting Pathway (Recommended Approach)

To register this remote service endpoint within your MCP client's configuration manifest (config.json), invoke the subsequent command via the Smithery CLI:

npx -y @smithery/cli install @shinzo-labs/gmail-mcp

You will be sequentially prompted to input your organization's CLIENT_ID, CLIENT_SECRET, and the user's REFRESH_TOKEN.

Smithery Software Development Kit (SDK)

Developers creating custom agent applications can utilize the provided starter code template available at Smithery server endpoint documentation.

NPX Direct Local Invocation

To establish local service operation using npx, incorporate the following configuration snippet into your MCP client's config.json:

{
  "mcpServers": {
    "gmail": {
      "command": "npx",
      "args": [
        "@shinzolabs/gmail-mcp"
      ]
    }
  }
}

Compilation From Source Repository

1. Obtain the source repository:

git clone https://github.com/shinzo-labs/gmail-mcp.git

1. Within the cloned directory, install dependencies and perform the build using pnpm:

pnpm i && pnpm build

1. Augment your MCP client config.json with this execution path definition:

{
  "mcpServers": {
    "gmail": {
      "command": "node",
      "args": [
        "/path/to/gmail-mcp/dist/index.js"
      ]
    }
  }
}

Environmental Configuration Parameters

Parameter Name	Description	Mandatory?	Default Value
AUTH_SERVER_PORT	Network port dedicated to the temporary OAuth authorization endpoint.	No	3000
CLIENT_ID	Identifier for the Google API Client (sourced from GMAIL_OAUTH_PATH).	Conditional (for remote linkage)	''
CLIENT_SECRET	Secret key for the Google API Client (sourced from GMAIL_OAUTH_PATH).	Conditional (for remote linkage)	''
GMAIL_CREDENTIALS_PATH	File system location pointing to the finalized user authorization token file.	No	MCP_CONFIG_DIR/credentials.json
GMAIL_OAUTH_PATH	Location of the Google API Client configuration data file.	No	MCP_CONFIG_DIR/gcp-oauth.keys.json
MCP_CONFIG_DIR	Root directory utilized for persistent storage of configuration artifacts.	No	~/.gmail-mcp
REFRESH_TOKEN	The user's long-lived OAuth refresh token (located in GMAIL_CREDENTIALS_PATH).	Conditional (for remote linkage)	''
PORT	TCP port assigned for communication utilizing the Streamable HTTP transport method.	No	3000
TELEMETRY_ENABLED	Flag to activate the transmission of diagnostic, anonymous usage data.	No	true

Accessible Operational Interfaces

User Account Administration

• get_profile: Retrieve metadata for the authenticated Gmail account holder.
• stop_mail_watch: Terminate active push subscription monitoring services.
• watch_mailbox: Initiate a webhook subscription to receive real-time updates on mailbox state changes.

Correspondence Unit Management

Message Manipulation

• list_messages: Enumerate messages, supporting complex query parameters for filtering.
• get_message: Fetch the full content or specific metadata of an individual email.
• get_attachment: Extract and retrieve a file payload attached to a message.
• modify_message: Apply or remove tags/labels associated with a message record.
• send_message: Transmit a newly composed or pre-formatted electronic message.
• delete_message: Permanently erase a message record from the system.
• trash_message: Move a message to the user's designated trash container.
• untrash_message: Restore a message from the trash container to its prior state/location.
• batch_modify_messages: Perform label modifications across a collection of messages simultaneously.
• batch_delete_messages: Execute mass deletion of multiple message entities.

Organizational Tag Administration

• list_labels: Obtain a registry of all defined organizational tags.
• get_label: Query details pertaining to a solitary, identified tag.
• create_label: Provision a novel organizational tag.
• update_label: Fully redefine the properties of an existing tag.
• patch_label: Apply granular, partial modifications to a tag's attributes.
• delete_label: Remove a tag definition from the system.

Conversation Thread Oversight

• list_threads: Display a compilation of message threads.
• get_thread: Fetch the complete message history within a specific thread.
• modify_thread: Adjust the tags applied to an entire conversation thread.
• trash_thread: Relegate an entire thread to the trash bin.
• untrash_thread: Return a trashed thread to active view.
• delete_thread: Eradicate a thread record permanently.

Pre-Send Item (Draft) Management

• list_drafts: Present a catalogue of unsent, saved draft messages.
• get_draft: Fetch the contents of a specific draft.
• create_draft: Save a newly composed message as a draft.
• update_draft: Overwrite and replace the current content of an existing draft.
• delete_draft: Remove a draft item from storage.
• send_draft: Initiate the transmission of an item previously saved as a draft.

Account Parameter Configuration

Automated Forwarding Rules

• get_auto_forwarding: Report on current automatic message redirection settings.
• update_auto_forwarding: Establish or alter the destination for automatic message forwarding.

IMAP Access Parameters

• get_imap: Retrieve the current configuration for IMAP access protocols.
• update_imap: Define or change settings governing IMAP connectivity.

POP Access Parameters

• get_pop: Obtain the existing configuration parameters for POP retrieval.
• update_pop: Set or modify the rules governing POP protocol usage.

Vacation Auto-Reply System

• get_vacation: Inspect the status and parameters of the out-of-office reply feature.
• update_vacation: Configure or deactivate the automated vacation response.

Interface Localization

• get_language: Fetch the currently configured interface language setting.
• update_language: Modify the primary language setting for the user interface.

Account Proxy Delegation

• list_delegates: List other users granted permission to manage this mailbox.
• get_delegate: Retrieve details for a single designated delegate.
• add_delegate: Grant mailbox management access to another user account.
• remove_delegate: Revoke mailbox access previously granted to a delegate.

Message Filtration Rules

• list_filters: Display all established message filtering rules.
• get_filter: Fetch the operational details of a specific filter rule.
• create_filter: Define a new rule to automatically process incoming mail.
• delete_filter: Deactivate and remove a message filter.

Authorized Forwarding Destinations

• list_forwarding_addresses: List all email addresses verified for receiving forwarded mail.
• get_forwarding_address: Get specific information about a verified forwarding address.
• create_forwarding_address: Initiate verification for a new address to receive forwarded mail.
• delete_forwarding_address: Remove a previously verified forwarding destination.

Sender Identity (Send-As) Aliases

• list_send_as: Catalog all configured email identities permitted for outgoing correspondence.
• get_send_as: Retrieve the configuration for one specific send-as identity.
• create_send_as: Provision a new alias identity for sending mail.
• update_send_as: Fully replace the details of an existing send-as alias.
• patch_send_as: Apply non-exhaustive modifications to a send-as alias configuration.
• verify_send_as: Dispatch a confirmation email to validate ownership of a new send-as address.
• delete_send_as: Remove a registered send-as identity.

Secure S/MIME Configuration

• list_smime_info: Obtain a roster of installed S/MIME cryptographic profiles.
• get_smime_info: Fetch the parameters for a specific S/MIME setting.
• insert_smime_info: Upload a new S/MIME configuration certificate/key pair.
• set_default_smime_info: Designate one S/MIME configuration as the default for signing/encryption.
• delete_smime_info: Remove an installed S/MIME configuration record.

Collaboration Guidelines

We enthusiastically welcome community involvement! Consult CONTRIBUTING.md for detailed procedures regarding bug reporting, code submissions, and primary points of contact.

Data Governance and Confidentiality

Shinzo Labs gathers minimal, anonymized performance telemetry from this server instance to facilitate continuous refinement of our service offerings. No data that can identify an individual user is captured during this process. Consult the Privacy Policy for comprehensive particulars on the telemetry captured and instructions on how to opt out of data collection.

Licensing

Licensed under the MIT terms.

WIKIPEDIA: Business management tools encompass all the methodologies, applications, computational solutions, and systems utilized by enterprises to effectively navigate fluctuating market conditions, maintain competitive relevance, and drive superior operational outcomes.

== System Overview == Management instruments can be functionally categorized based on the operational domain they serve within an organization. Examples include tools for resource allocation planning, operational process governance, archival and record-keeping, personnel administration, strategic forecasting, performance monitoring, etc. A functional typology often incorporates these broad areas:

Instruments employed for data entry verification across any organizational segment. Software designed for auditing and enhancing organizational workflows. Platforms utilized for data aggregation and derivation of executive insights. Technological advancements have radically reshaped the landscape of management tools over the past decade, leading to an overwhelming proliferation of choices. This complexity is fueled by constant pressure to reduce operational expenditure, maximize revenue streams, deepen comprehension of client demands, and excel in product delivery according to specification. Consequently, executives must adopt a strategic viewpoint regarding management tool acquisition, prioritizing thoughtful integration over the adoption of the newest available solution. Often, managers err by deploying tools without requisite customization, inducing systemic instability. Appropriate business instrumentation must be selected deliberately and subsequently tailored to the unique requirements of the entity, not the reverse.

== Prominent Selections (2013 Survey) == Research conducted by Bain & Company in 2013 mapped the global deployment patterns of business management instrumentation, reflecting regional priorities shaped by economic conditions. The top ten instruments identified were:

Strategic planning frameworks Customer relationship management systems Personnel satisfaction assessment tools Competitive benchmarking procedures Balanced scorecard methodology Core competency identification Outsourcing strategy implementation Organizational change management programs Supply chain optimization protocols Mission and vision definition processes Market segmentation analysis Total quality management systems

== Enterprise Software Applications == Collections of software programs deployed by commercial entities to execute diverse corporate functions are known as business software or enterprise applications. These systems are instrumental in augmenting productivity, accurately measuring performance indicators, and executing specialized transactional duties. The evolution progressed from initial Management Information Systems (MIS) to comprehensive Enterprise Resource Planning (ERP) suites, subsequently incorporating Customer Relationship Management (CRM), culminating in the present domain of cloud-based business management solutions. Although organizational IT investment correlates with performance gains, two factors are paramount for realizing substantive value: the proficiency of the deployment process and the judicious selection and customization of the tools themselves.

== Instruments for Small and Medium Enterprises (SMEs) == Tools specifically designed for SMEs are crucial as they offer mechanisms to optimize resource utilization...