diff --git a/README.md b/README.md index a7b8867..3761b99 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,60 @@ - - # Pydantic Logfire MCP Server This repository contains a Model Context Protocol (MCP) server with tools that can access the OpenTelemetry traces and metrics you've sent to Pydantic Logfire. +## Remote MCP Server (Recommended) + +Pydantic Logfire provides a hosted remote MCP server that you can use instead of running this package locally. +This is the easiest way to get started with the Logfire MCP server. + +To use the remote MCP server, add the following configuration to your MCP client. + +**Choose the endpoint that matches your Logfire data region:** + +For **US region** (`logfire-us.pydantic.dev`): +```json +{ + "mcpServers": { + "logfire": { + "type": "http", + "url": "https://logfire-us.pydantic.dev/mcp" + } + } +} +``` + +For **EU region** (`logfire-eu.pydantic.dev`): +```json +{ + "mcpServers": { + "logfire": { + "type": "http", + "url": "https://logfire-eu.pydantic.dev/mcp" + } + } +} +``` + +> [!NOTE] +> The remote MCP server handles authentication automatically through your browser. When you first connect, +> you'll be prompted to authenticate with your Pydantic Logfire account. + +> [!NOTE] +> If you are running a self-hosted Logfire instance, you should use the [Running Locally](#running-locally) section below +> to configure the MCP server with your custom base URL. + +--- + +## Running Locally (Deprecated) + +> [!WARNING] +> Running the MCP server locally is deprecated. Please use the [Remote MCP Server](#remote-mcp-server-recommended) instead. +> The local server will continue to work, but we recommend migrating to the remote server for a better experience. + +If you prefer to run the MCP server locally (for example, for self-hosted Logfire or custom configurations), +you can use this package instead. + Pydantic Logfire Server MCP server @@ -17,12 +67,12 @@ traces, and make use of the results of arbitrary SQL queries executed using the * `find_exceptions_in_file` - Get the details about the 10 most recent exceptions on the file. * Arguments: * `filepath` (string) - The path to the file to find exceptions in. - * `age` (integer) - Number of minutes to look back, e.g. 30 for last 30 minutes. Maximum allowed value is 7 days. + * `age` (integer) - Number of minutes to look back, e.g. 30 for last 30 minutes. Maximum allowed value is 30 days. * `arbitrary_query` - Run an arbitrary query on the Pydantic Logfire database. * Arguments: * `query` (string) - The query to run, as a SQL string. - * `age` (integer) - Number of minutes to look back, e.g. 30 for last 30 minutes. Maximum allowed value is 7 days. + * `age` (integer) - Number of minutes to look back, e.g. 30 for last 30 minutes. Maximum allowed value is 30 days. * `logfire_link` - Creates a link to help the user to view the trace in the Logfire UI. * Arguments: diff --git a/tests/README.md.jinja b/tests/README.md.jinja index 7de4079..1a9677e 100644 --- a/tests/README.md.jinja +++ b/tests/README.md.jinja @@ -3,6 +3,58 @@ This repository contains a Model Context Protocol (MCP) server with tools that can access the OpenTelemetry traces and metrics you've sent to Pydantic Logfire. +## Remote MCP Server (Recommended) + +Pydantic Logfire provides a hosted remote MCP server that you can use instead of running this package locally. +This is the easiest way to get started with the Logfire MCP server. + +To use the remote MCP server, add the following configuration to your MCP client. + +**Choose the endpoint that matches your Logfire data region:** + +For **US region** (`logfire-us.pydantic.dev`): +```json +{ + "mcpServers": { + "logfire": { + "type": "http", + "url": "https://logfire-us.pydantic.dev/mcp" + } + } +} +``` + +For **EU region** (`logfire-eu.pydantic.dev`): +```json +{ + "mcpServers": { + "logfire": { + "type": "http", + "url": "https://logfire-eu.pydantic.dev/mcp" + } + } +} +``` + +> [!NOTE] +> The remote MCP server handles authentication automatically through your browser. When you first connect, +> you'll be prompted to authenticate with your Pydantic Logfire account. + +> [!NOTE] +> If you are running a self-hosted Logfire instance, replace the URL above with your own Logfire instance URL +> (e.g., `https://logfire.my-company.com/mcp`), as the remote MCP server is hosted alongside your Logfire deployment. + +--- + +## Running Locally (Deprecated) + +> [!WARNING] +> Running the MCP server locally is deprecated. Please use the [Remote MCP Server](#remote-mcp-server-recommended) instead. +> The local server will continue to work, but we recommend migrating to the remote server for a better experience. + +If you prefer to run the MCP server locally (for example, for self-hosted Logfire or custom configurations), +you can use this package instead. + Pydantic Logfire Server MCP server