Skip to main content

Python SDK for tool usage logging and monitoring

Project description

Observe Python SDK

A Python SDK for MCP tool and prompt usage logging and monitoring.

Installation

pip install observee

Usage

You can set the MCP server name either globally or per decorator:

Global Configuration

from observee import ObserveeConfig, observee_usage_logger

# Set the MCP server name globally
ObserveeConfig.set_mcp_server_name("your-mcp-server-name")

# Auto-detection based on function name
@observee_usage_logger
async def your_tool_function():
    # Your tool code here
    pass

@observee_usage_logger
async def generate_prompt():
    # Your prompt code here - auto-detected as prompt
    pass

API Key Configuration (Developers and Enterprise Customers)

from observee import ObserveeConfig

# Set your API key
ObserveeConfig.set_api_key("your-api-key")

Unified Usage Logging

from observee import ObserveeConfig, observee_usage_logger

# Auto-detection based on function name (recommended)
@observee_usage_logger()
async def your_tool_function():
    # Your tool code here
    pass

@observee_usage_logger()
async def generate_prompt():
    # Your prompt code here
    pass

Features

  • Unified decorator for both tool and prompt usage logging with async support
  • Auto-detection of usage type based on function names (or explicit specification)
  • Automatic logging of:
    • Tool/prompt name
    • Input parameters
    • Response data
    • Execution duration (for tools only)
    • Error information (if any)
  • Configurable logging endpoint (defaults to Observe API)
  • Error handling and reporting
  • Performance tracking (for tools only)
  • Flexible MCP server name configuration
  • API key support for enhanced features
  • Privacy protection: Input/response data only logged when API key is provided

Logging Details

Unified Usage Logging

The SDK uses a single @observee_usage_logger() decorator that can automatically detect whether you're logging a tool or prompt based on the function name, or you can specify explicitly:

Auto-detection: Functions containing keywords like 'prompt', 'template', or 'message' in their name are detected as prompts. All others are treated as tools.

Tool logging includes:

  • MCP server name
  • Tool name (derived from function name)
  • Tool input parameters (as JSON)
  • Tool response
  • Execution duration in milliseconds
  • Any errors that occur during execution

Prompt logging includes:

  • MCP server name
  • Prompt name (derived from function name)
  • Prompt input parameters (as JSON)
  • Prompt response
  • Any errors that occur during execution

Privacy Protection

For privacy protection, detailed input and response data is only logged when an API key is configured. Without an API key, only basic metadata is logged:

  • For tools: server name, tool name, and execution duration
  • For prompts: server name and prompt name

Logs are sent asynchronously to avoid impacting tool/prompt performance.

Requirements

  • Python 3.8 or higher
  • Dependencies:
    • httpx
    • pydantic

License

GPL v3 - see LICENSE file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_logger-0.1.21.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_logger-0.1.21-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file mcp_logger-0.1.21.tar.gz.

File metadata

  • Download URL: mcp_logger-0.1.21.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for mcp_logger-0.1.21.tar.gz
Algorithm Hash digest
SHA256 d11255abc01627270f6c4eb3a396194811affa01922afaca6e40ec23254ae9ec
MD5 85b7e87b67f01948396573c07fe8e09e
BLAKE2b-256 981c735ec39897a62357c1763fae240e46ce724e5fca96500c0aa95013b3fb06

See more details on using hashes here.

File details

Details for the file mcp_logger-0.1.21-py3-none-any.whl.

File metadata

  • Download URL: mcp_logger-0.1.21-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for mcp_logger-0.1.21-py3-none-any.whl
Algorithm Hash digest
SHA256 6fde1d38a4945e72e2ce6fd7f66ded87cab881f53d5466d19d3839ed21a13d5c
MD5 9a0815567aaea74572553b4e92f17135
BLAKE2b-256 92b695eba1efda4d7a0c1fc3e20ad527cf6d78c8a9de4415e1ca955c9a9381d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page