@gleanwork/mcp-server MCP Server: Integrating AI Applications into the Glean Ecosystem

Overview: What is @gleanwork/mcp-server?

@gleanwork/mcp-server is a Model Context Protocol (MCP) server implementation designed to enhance and integrate AI applications with Glean's robust content search and chat functionalities. This MCP server adheres to the MCP specification, providing a standardized interface that various AI clients can use to leverage Glean’s advanced capabilities in a seamless and interoperable manner.

🔧 Core Features & MCP Capabilities

@gleanwork/mcp-server offers several key features and MCP capabilities:

1. Search Integration: Access Glean's powerful content search functionality, allowing users to query and retrieve relevant information from the vast Glean content index.
2. Chat Interface: Facilitate interactive conversations with Glean’s AI assistant using the chat API, supporting various configurations like message history and citations.
3. AI Application Compatibility: Compatible with multiple MCP clients such as Claude Desktop, Cursor, and Continue, ensuring that developers can easily integrate their applications.

⚙️ MCP Architecture & Protocol Implementation

@gleanwork/mcp-server is built to adhere strictly to the MCP protocol specification, enabling seamless communication between AI applications and Glean's content search and chat features. The server leverages REST API calls for interacting with Glean’s services, providing a robust and flexible solution.

Mermaid Diagram: MCP Protocol Flow

graph TD
    A[AI Application] -->|MCP Client| B[MCP Server]
    B --> C[Glean Search & Chat API]
    C --> D[Data Source/Tool]
    style A fill:#e1f5fe
    style C fill:#f3e5f5
    style D fill:#ffffff

Mermaid Diagram: Data Architecture

graph TD
    G[Global Configuration] --> H[MCP Server]
    I[Data Source/Tool] --> J[Cached Data]
    K[Cached Data] --> L[MCP Client]
    M[MCP Client] --> N[AI Application]
    style G fill:#f5e3fb
    style H fill:#fce8d7
    style I fill:#b0e0e6
    style J fill:#d1ffee
    style K fill:#bdegne
    style L fill:#e0f2ff
    style M fill:#f5ebde

🚀 Getting Started with Installation

To get started, it’s essential to configure your Glean API credentials and ensure that the environment is properly set up. Here are the steps to follow:

1. Set Up Environment Variables:

   export GLEAN_SUBDOMAIN=your_subdomain
   export GLEAN_API_TOKEN=your_api_token
   

2. Configure for MCP Client (for Cursor, Claude Desktop, or Windsurf):

   npx @gleanwork/mcp-server configure --client [Client Name] --token your_api_token --domain your_subdomain
   

Alternatively, you can use an environment file to set up the configuration:

npx @gleanwork/mcp-server configure --client [Client Name] --env path/to/.env.glean

The .env.glean file should contain:

GLEAN_SUBDOMAIN=your_subdomain
GLEAN_API_TOKEN=your_api_token

💡 Key Use Cases in AI Workflows

1. Content Discovery and Retrieval:
   • Developers can integrate @gleanwork/mcp-server with their applications to enable users to search for relevant content across Glean’s vast database.
2. Conversational AI Enhancements:
   • By incorporating chat functionality, developers enhance the conversational capabilities of their AI models, enabling more informed and context-rich interactions.

🔌 Integration with MCP Clients

@gleanwork/mcp-server is designed to be compatible with multiple MCP clients, including Claude Desktop, Continue, Cursor, and others. Here’s a compatibility matrix showcasing supported features:

MCP Client	Resources	Tools	Prompts	Status
Claude Desktop	✅	✅	✅	Full Support
Continue	✅	✅	✅	Full Support
Cursor	❌(limited)	✅	❌	Tools Only

📊 Performance & Compatibility Matrix

The performance and compatibility of @gleanwork/mcp-server have been rigorously tested to ensure optimal functionality. The server is designed to handle high volumes of requests while maintaining low latency, making it suitable for real-time applications.

Example Usage Scenario: Content Extraction from Glean Index

1. Setup Configuration: Configure the MCP client with API credentials and domain.
2. Perform Search: Use the search tool to query content from Glean’s index.
3. Integrate Results: Integrate the retrieved data into your application for further processing.

Example Usage Scenario: Chat Interactions

1. Set up Client: Initialize the client configuration with necessary API tokens and subdomain details.
2. Send Messages: Use Glean's chat functionality to conduct interactive conversations, capturing context and previous interactions seamlessly.

🛠️ Advanced Configuration & Security

Advanced users can configure various aspects of the MCP server for enhanced security and performance:

• API Token Management: Ensure that API tokens with the correct scopes (chat, search) are used.
• Environment Variables: Set up environment variables to securely manage sensitive information, such as API keys and subdomains.

❓ Frequently Asked Questions (FAQ)

1. Q: Can @gleanwork/mcp-server integrate with multiple MCP clients?
   A: Yes, it is compatible with various clients like Claude Desktop, Continue, Cursor, etc., ensuring a unified experience across different AI applications.
2. Q: How does the configuration process work for different MCP clients?
   A: You can configure the server using environment variables or by setting up an .env.glean file that contains necessary credentials and domain information.
3. Q: Are there specific tools required to debug @gleanwork/mcp-server?
   A: Yes, you can use the MCP Inspector tool for debugging purposes over stdio.
4. Q: How does @gleanwork/mcp-server handle security?
   A: The server requires specific API tokens with proper scopes and leverages environment variables to manage sensitive information securely.
5. Q: What are the typical use cases for @gleanwork/mcp-server in AI applications?
   A: It is ideal for content discovery, chat integration, and providing users with comprehensive search capabilities.

👨‍💻 Development & Contribution Guidelines

Contributions to @gleanwork/mcp-server are highly valued. Developers can contribute by following the guidelines outlined in CONTRIBUTING.md.

🌐 MCP Ecosystem & Resources

For detailed information and additional resources, refer to:

• Documentation: docs.glean.com
• Support: Email support at @gleanwork.support

By leveraging @gleanwork/mcp-server, users can integrate advanced AI capabilities into their applications seamlessly and efficiently.