Skip to content
This repository was archived by the owner on Mar 24, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 54 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,60 @@
<!-- DO NOT MODIFY THIS FILE DIRECTLY, IT IS GENERATED BY THE TESTS! -->

# 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.

<a href="https://glama.ai/mcp/servers/@pydantic/logfire-mcp">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@pydantic/logfire-mcp/badge" alt="Pydantic Logfire Server MCP server" />
</a>
Expand All @@ -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:
Expand Down
52 changes: 52 additions & 0 deletions tests/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,58 @@
This repository contains a Model Context Protocol (MCP) server with tools that can access the OpenTelemetry traces and
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have text between heading sections.

metrics you've sent to Pydantic Logfire.

## Remote MCP Server (Recommended)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have a note about self hosted.


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.

<a href="https://glama.ai/mcp/servers/@pydantic/logfire-mcp">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@pydantic/logfire-mcp/badge" alt="Pydantic Logfire Server MCP server" />
</a>
Expand Down