Skip to content
This repository was archived by the owner on Mar 24, 2026. It is now read-only.

Update tests/README.md.jinja #56

Merged
hramezani merged 1 commit into from
Feb 20, 2026
Merged

Update tests/README.md.jinja #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ For **EU region** (`logfire-eu.pydantic.dev`):
> 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.
> If you want to run logfire-mcp locally, check the [OLD_README.md](OLD_README.md) file.

## Configuration with well-known MCP clients

Expand Down
221 changes: 21 additions & 200 deletions tests/README.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ To use the remote MCP server, add the following configuration to your MCP client

**Choose the endpoint that matches your Logfire data region:**

- **US region** — `logfire-us.pydantic.dev`
- **EU region** — `logfire-eu.pydantic.dev`

For **US region** (`logfire-us.pydantic.dev`):
```json
{
Expand Down Expand Up @@ -41,102 +44,12 @@ For **EU region** (`logfire-eu.pydantic.dev`):
> 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, 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>

This MCP server enables LLMs to retrieve your application's telemetry data, analyze distributed
traces, and make use of the results of arbitrary SQL queries executed using the Pydantic Logfire APIs.

## Available Tools

{% for tool in tools -%}
* `{{ tool.name }}` - {{ tool.description }}
{%- if tool.arguments %}
* Arguments:
{%- for argument in tool.arguments %}
* `{{ argument.name }}` ({{ argument.type }}) - {{ argument.description }}
{%- endfor %}
{%- endif %}

{% endfor %}
## Setup

### Install `uv`

The first thing to do is make sure `uv` is installed, as `uv` is used to run the MCP server.

For installation instructions, see the [`uv` installation docs](https://docs.astral.sh/uv/getting-started/installation/).

If you already have an older version of `uv` installed, you might need to update it with `uv self update`.

### Obtain a Pydantic Logfire read token
In order to make requests to the Pydantic Logfire APIs, the Pydantic Logfire MCP server requires a "read token".

You can create one under the "Read Tokens" section of your project settings in Pydantic Logfire:
https://logfire.pydantic.dev/-/redirect/latest-project/settings/read-tokens

> [!IMPORTANT]
> Pydantic Logfire read tokens are project-specific, so you need to create one for the specific project you want to expose to the Pydantic Logfire MCP server.

### Manually run the server

Once you have `uv` installed and have a Pydantic Logfire read token, you can manually run the MCP server using `uvx` (which is provided by `uv`).

You can specify your read token using the `LOGFIRE_READ_TOKEN` environment variable:

```bash
LOGFIRE_READ_TOKEN=YOUR_READ_TOKEN uvx logfire-mcp@latest
```

You can also set `LOGFIRE_READ_TOKEN` in a `.env` file:

```bash
LOGFIRE_READ_TOKEN=pylf_v1_us_...
```

**NOTE:** for this to work, the MCP server needs to run with the directory containing the `.env` file in its working directory.

or using the `--read-token` flag:

```bash
uvx logfire-mcp@latest --read-token=YOUR_READ_TOKEN
```
> [!NOTE]
> If you are using Cursor, Claude Desktop, Cline, or other MCP clients that manage your MCP servers for you, you **_do
NOT_** need to manually run the server yourself. The next section will show you how to configure these clients to make
use of the Pydantic Logfire MCP server.

### Base URL

If you are running Logfire in a self hosted environment, you need to specify the base URL.
This can be done using the `LOGFIRE_BASE_URL` environment variable:

```bash
LOGFIRE_BASE_URL=https://logfire.my-company.com uvx logfire-mcp@latest --read-token=YOUR_READ_TOKEN
```

You can also use the `--base-url` argument:

```bash
uvx logfire-mcp@latest --base-url=https://logfire.my-company.com --read-token=YOUR_READ_TOKEN
```
> If you want to run logfire-mcp locally, check the [OLD_README.md](OLD_README.md) file.

## Configuration with well-known MCP clients

The examples below use the **US region** endpoint. Replace the URL with `https://logfire-eu.pydantic.dev/mcp` if you are using the EU region.

### Configure for Cursor

Create a `.cursor/mcp.json` file in your project root:
Expand All @@ -145,21 +58,19 @@ Create a `.cursor/mcp.json` file in your project root:
{
"mcpServers": {
"logfire": {
"command": "uvx",
"args": ["logfire-mcp@latest", "--read-token=YOUR-TOKEN"]
"type": "http",
"url": "https://logfire-us.pydantic.dev/mcp"
}
}
}
```

The Cursor doesn't accept the `env` field, so you need to use the `--read-token` flag instead.

### Configure for Claude code
### Configure for Claude Code

Run the following command:

```bash
claude mcp add logfire -e LOGFIRE_READ_TOKEN=YOUR_TOKEN -- uvx logfire-mcp@latest
claude mcp add logfire --type http --url https://logfire-us.pydantic.dev/mcp
```

### Configure for Claude Desktop
Expand All @@ -168,11 +79,11 @@ Add to your Claude settings:

```json
{
"command": ["uvx"],
"args": ["logfire-mcp@latest"],
"type": "stdio",
"env": {
"LOGFIRE_READ_TOKEN": "YOUR_TOKEN"
"mcpServers": {
"logfire": {
"type": "http",
"url": "https://logfire-us.pydantic.dev/mcp"
}
}
}
```
Expand All @@ -185,13 +96,8 @@ Add to your Cline settings in `cline_mcp_settings.json`:
{
"mcpServers": {
"logfire": {
"command": "uvx",
"args": ["logfire-mcp@latest"],
"env": {
"LOGFIRE_READ_TOKEN": "YOUR_TOKEN"
},
"disabled": false,
"autoApprove": []
"type": "http",
"url": "https://logfire-us.pydantic.dev/mcp"
}
}
}
Expand All @@ -207,12 +113,8 @@ Create a `.vscode/mcp.json` file in your project's root directory:
{
"servers": {
"logfire": {
"type": "stdio",
"command": "uvx", // or the absolute /path/to/uvx
"args": ["logfire-mcp@latest"],
"env": {
"LOGFIRE_READ_TOKEN": "YOUR_TOKEN"
}
"type": "http",
"url": "https://logfire-us.pydantic.dev/mcp"
}
}
}
Expand All @@ -226,90 +128,9 @@ Create a `.zed/settings.json` file in your project's root directory:
{
"context_servers": {
"logfire": {
"source": "custom",
"command": "uvx",
"args": ["logfire-mcp@latest"],
"env": {
"LOGFIRE_READ_TOKEN": "YOUR_TOKEN"
},
"enabled": true
"type": "http",
"url": "https://logfire-us.pydantic.dev/mcp"
}
}
}
```

## Example Interactions

1. Get details about exceptions from traces in a specific file:
```json
{
"name": "find_exceptions_in_file",
"arguments": {
"filepath": "app/api.py",
"age": 1440
}
}
```

Response:
```json
[
{
"created_at": "2024-03-20T10:30:00Z",
"message": "Failed to process request",
"exception_type": "ValueError",
"exception_message": "Invalid input format",
"function_name": "process_request",
"line_number": "42",
"attributes": {
"service.name": "api-service",
"code.filepath": "app/api.py"
},
"trace_id": "1234567890abcdef"
}
]
```

2. Run a custom query on traces:
```json
{
"name": "arbitrary_query",
"arguments": {
"query": "SELECT trace_id, message, created_at, attributes->>'service.name' as service FROM records WHERE severity_text = 'ERROR' ORDER BY created_at DESC LIMIT 10",
"age": 1440
}
}
```

## Examples of Questions for Claude

1. "What exceptions occurred in traces from the last hour across all services?"
2. "Show me the recent errors in the file 'app/api.py' with their trace context"
3. "How many errors were there in the last 24 hours per service?"
4. "What are the most common exception types in my traces, grouped by service name?"
5. "Get me the OpenTelemetry schema for traces and metrics"
6. "Find all errors from yesterday and show their trace contexts"

## Getting Started

1. First, obtain a Pydantic Logfire read token from:
https://logfire.pydantic.dev/-/redirect/latest-project/settings/read-tokens

2. Run the MCP server:
```bash
uvx logfire-mcp@latest --read-token=YOUR_TOKEN
```

3. Configure your preferred client (Cursor, Claude Desktop, or Cline) using the configuration examples above

4. Start using the MCP server to analyze your OpenTelemetry traces and metrics!

## Contributing

We welcome contributions to help improve the Pydantic Logfire MCP server. Whether you want to add new trace analysis tools, enhance metrics querying functionality, or improve documentation, your input is valuable.

For examples of other MCP servers and implementation patterns, see the [Model Context Protocol servers repository](https://github.com/modelcontextprotocol/servers).

## License

Pydantic Logfire MCP is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License.