Mcp samples for env server and long running

Author: edis-uipath

samples/mcp-env-server/README.md

@@ -0,0 +1,118 @@
+# Environment Variables MCP Server
+
+This sample demonstrates how to create an MCP server that provides tools for accessing environment variables in a secure and controlled manner.
+
+## Overview
+
+The Environment Variables MCP Server provides three main tools:
+
+1. **get_environment_variable** - Retrieve the value of a specific environment variable
+2. **list_environment_variables** - List all environment variables, optionally filtered by pattern
+3. **check_environment_variable** - Check if an environment variable exists without returning its value
+
+## Features
+
+- **Secure access** to environment variables with proper error handling
+- **Pattern-based filtering** when listing environment variables
+- **Existence checking** without value exposure
+- **Comprehensive error handling** with detailed status messages
+- **Structured responses** with consistent JSON format
+
+## Installation
+
+```bash
+uv venv -p 3.11 .venv
+.venv\Scripts\activate
+uv sync
+```
+
+## Usage
+
+### Get Environment Variable
+
+Retrieve the value of a specific environment variable:
+
+```python
+# Example usage
+get_environment_variable("PATH")
+# Returns: {"status": "success", "name": "PATH", "value": "/usr/bin:/bin", "message": "Environment variable 'PATH' retrieved successfully"}
+
+get_environment_variable("NON_EXISTENT_VAR")
+# Returns: {"status": "not_found", "name": "NON_EXISTENT_VAR", "value": None, "message": "Environment variable 'NON_EXISTENT_VAR' is not set"}
+```
+
+### List Environment Variables
+
+List all environment variables or filter by pattern:
+
+```python
+# List all environment variables
+list_environment_variables()
+
+# Filter by pattern (case-insensitive)
+list_environment_variables("PATH")
+# Returns variables containing "PATH" in their name
+```
+
+### Check Environment Variable
+
+Check if an environment variable exists without exposing its value:
+
+```python
+check_environment_variable("HOME")
+# Returns: {"status": "success", "name": "HOME", "exists": True, "message": "Environment variable 'HOME' exists"}
+```
+
+## Security Considerations
+
+- Environment variables may contain sensitive information (API keys, passwords, etc.)
+- Use with caution in production environments
+- Consider implementing access controls or filtering for sensitive variables
+- The `check_environment_variable` tool provides a way to verify existence without exposing values
+
+## Configuration
+
+The server is configured through standard MCP configuration files:
+
+- `mcp.json` - Defines the server transport and command
+- `pyproject.toml` - Python project configuration and dependencies
+- `uipath.json` - UiPath platform integration settings
+
+## Running the Server
+
+To run the server locally for debugging:
+
+```bash
+uipath run env-server
+```
+
+To package and deploy:
+
+```bash
+uipath pack
+uipath publish
+```
+
+## Example Responses
+
+All tools return structured JSON responses with consistent formatting:
+
+```json
+{
+  "status": "success|not_found|error",
+  "name": "VARIABLE_NAME",
+  "value": "variable_value_or_null",
+  "message": "Descriptive message about the operation"
+}
+```
+
+For listing operations:
+
+```json
+{
+  "status": "success|error",
+  "count": 42,
+  "variables": {"VAR1": "value1", "VAR2": "value2"},
+  "message": "Found 42 environment variables"
+}
+```

samples/mcp-env-server/mcp.json

@@ -0,0 +1,9 @@
+{
+  "servers": {
+    "env-server": {
+        "transport": "stdio",
+        "command": "python",
+        "args": ["server.py"]
+    }
+  }
+}

samples/mcp-env-server/pyproject.toml

@@ -0,0 +1,9 @@
+[project]
+name = "mcp-env-server"
+version = "0.0.1"
+description = "Environment Variables MCP Server"
+authors = [{ name = "John Doe" }]
+dependencies = [
+    "uipath-mcp>=0.0.78",
+]
+requires-python = ">=3.10"

samples/mcp-env-server/server.py

@@ -0,0 +1,116 @@
+import os
+from typing import Dict, Any, Optional
+
+from mcp.server.fastmcp import FastMCP
+
+mcp = FastMCP("Environment Variables MCP Server")
+
+
+@mcp.tool()
+def get_environment_variable(name: str) -> Dict[str, Any]:
+    """Get the value of an environment variable by name.
+
+    Args:
+        name: The name of the environment variable to retrieve
+
+    Returns:
+        Dictionary containing the variable name, value, and status information
+    """
+    try:
+        value = os.environ.get(name)
+        
+        if value is None:
+            return {
+                "status": "not_found",
+                "name": name,
+                "value": None,
+                "message": f"Environment variable '{name}' is not set"
+            }
+        
+        return {
+            "status": "success",
+            "name": name,
+            "value": value,
+            "message": f"Environment variable '{name}' retrieved successfully"
+        }
+    
+    except Exception as e:
+        return {
+            "status": "error",
+            "name": name,
+            "value": None,
+            "message": f"Error retrieving environment variable '{name}': {str(e)}"
+        }
+
+
+@mcp.tool()
+def list_environment_variables(pattern: Optional[str] = None) -> Dict[str, Any]:
+    """List all environment variables, optionally filtered by a pattern.
+
+    Args:
+        pattern: Optional pattern to filter environment variable names (case-insensitive substring match)
+
+    Returns:
+        Dictionary containing the list of environment variables and their values
+    """
+    try:
+        env_vars = dict(os.environ)
+        
+        if pattern:
+            # Filter environment variables by pattern (case-insensitive)
+            filtered_vars = {
+                key: value for key, value in env_vars.items()
+                if pattern.lower() in key.lower()
+            }
+        else:
+            filtered_vars = env_vars
+        
+        return {
+            "status": "success",
+            "count": len(filtered_vars),
+            "variables": filtered_vars,
+            "message": f"Found {len(filtered_vars)} environment variables" + 
+                      (f" matching pattern '{pattern}'" if pattern else "")
+        }
+    
+    except Exception as e:
+        return {
+            "status": "error",
+            "count": 0,
+            "variables": {},
+            "message": f"Error listing environment variables: {str(e)}"
+        }
+
+
+@mcp.tool()
+def check_environment_variable(name: str) -> Dict[str, Any]:
+    """Check if an environment variable exists without returning its value.
+
+    Args:
+        name: The name of the environment variable to check
+
+    Returns:
+        Dictionary containing the existence status of the environment variable
+    """
+    try:
+        exists = name in os.environ
+        
+        return {
+            "status": "success",
+            "name": name,
+            "exists": exists,
+            "message": f"Environment variable '{name}' {'exists' if exists else 'does not exist'}"
+        }
+    
+    except Exception as e:
+        return {
+            "status": "error",
+            "name": name,
+            "exists": False,
+            "message": f"Error checking environment variable '{name}': {str(e)}"
+        }
+
+
+# Run the server when the script is executed
+if __name__ == "__main__":
+    mcp.run()

samples/mcp-env-server/uipath.json

@@ -0,0 +1,11 @@
+{
+    "entryPoints": [
+        {
+            "filePath": "env-server",
+            "uniqueId": "a1b2c3d4-5678-90ab-cdef-123456789012",
+            "type": "mcpserver",
+            "input": {},
+            "output": {}
+        }
+    ]
+}