generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 7
Add MCP Server #357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
manototh
wants to merge
9
commits into
main
Choose a base branch
from
mano/mcp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add MCP Server #357
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c3cef58
First draft
manototh dad8631
Update mcp-server.mdx
manototh 9fde17d
Update mcp-server.mdx
manototh 4ce6c71
Update docs.json
manototh a54a409
Update mcp-server.mdx
manototh a8dbf4d
After testing
manototh e87a958
Update mcp-server.mdx
manototh 2afa469
Merge branch 'main' into mano/mcp
manototh 19cac0e
Update mcp-server.mdx
manototh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
--- | ||
title: Axiom MCP Server | ||
description: "This page explains how to get deeper insights with Axiom MCP Server." | ||
sidebarTitle: MCP Server | ||
--- | ||
|
||
import ReplaceDomain from "/snippets/replace-domain.mdx" | ||
|
||
Axiom MCP Server is a [Model Context Protocol](https://modelcontextprotocol.io/) server implementation that enables AI agents to query your data using Axiom Processing Language (APL). | ||
|
||
<Info> | ||
The Axiom MCP Server is an open-source project and welcomes your contributions. For more information, see the [GitHub repository](https://github.com/axiomhq/mcp-server-axiom). | ||
</Info> | ||
|
||
## Current capabilities | ||
|
||
Axiom MCP Server is compatible with the [Claude desktop app](https://claude.ai/download). | ||
|
||
Axiom MCP Server supports the following MCP [tools](https://modelcontextprotocol.io/docs/concepts/tools): | ||
|
||
- `queryApl`: Execute APL queries against Axiom datasets | ||
- `listDatasets`: List available Axiom datasets | ||
- `getDatasetSchema`: Get dataset schema | ||
- `getSavedQueries`: Retrieve saved APL queries | ||
- `getMonitors`: List monitoring configurations | ||
- `getMonitorsHistory`: Get monitor execution history | ||
|
||
Axiom plans to support MCP [resources](https://modelcontextprotocol.io/docs/concepts/resources) and [prompts](https://modelcontextprotocol.io/docs/concepts/prompts) in the future. | ||
|
||
## Prerequisites | ||
|
||
- [Create an Axiom account](https://app.axiom.co/register). | ||
- [Create a dataset in Axiom](/reference/datasets#create-dataset) and [send data to it](/send-data/methods). | ||
- [Create a Personal Access Tokens (PAT) in Axiom](/reference/tokens). The MCP Server doesn’t work with API tokens. | ||
- Install the [Claude desktop app](https://claude.ai/download). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It feels strange to me that we're listing a specific client as a pre-requisite. The Axiom MCP server will work with anything that supports MCP |
||
|
||
## Install | ||
|
||
Run the following to install the latest built binary from [GitHub](https://github.com/axiomhq/axiom-mcp/releases): | ||
|
||
```bash | ||
go install github.com/axiomhq/axiom-mcp@latest | ||
``` | ||
|
||
## Configure | ||
|
||
Configure the Claude app to use the MCP server in one of the following ways: | ||
|
||
- Use a [config file](#config-file) | ||
- Use [environment variables](#environment-variables) | ||
|
||
### Config file | ||
|
||
1. Create a config file where you specify the authentication and configuration details. For example: | ||
|
||
```bash config.txt | ||
token PERSONAL_ACCESS_TOKEN | ||
url https://AXIOM_DOMAIN | ||
org-id ORG_ID | ||
query-rate 1 | ||
query-burst 1 | ||
datasets-rate 1 | ||
datasets-burst 1 | ||
``` | ||
|
||
<Info> | ||
Replace `PERSONAL_ACCESS_TOKEN` with the Axiom PAT you have generated. | ||
|
||
<ReplaceDomain /> | ||
|
||
Replace `ORG_ID` with the name of your Axiom organization. For more information, see [Determine organization ID](/reference/tokens#determine-organization-id). | ||
</Info> | ||
|
||
Optionally, configure the rate and the burst at the query and dataset levels. | ||
|
||
1. Add `axiom` to the `mcpServers` section of the Claude configuration file. If you use a Mac, the default path is `~/Library/Application Support/Claude/claude_desktop_config.json`. | ||
|
||
```json claude_desktop_config.json | ||
{ | ||
"mcpServers": { | ||
"axiom": { | ||
"command": "PATH_AXIOM_MCP_BINARY", | ||
"args" : ["--config", "PATH_AXIOM_MCP_CONFIG"] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
<Info> | ||
Replace `PATH_AXIOM_MCP_BINARY` with the path the binary file of the Axiom MCP Server. By default, it’s `~/go/bin/axiom-mcp`. | ||
|
||
Replace `PATH_AXIOM_MCP_CONFIG` with the path the config file you have previously created. | ||
</Info> | ||
|
||
### Environment variables | ||
|
||
Add `axiom` to the `mcpServers` section of the Claude configuration file, and specify the authentication details using environment variables. If you use a Mac, the default path is `~/Library/Application Support/Claude/claude_desktop_config.json`. For example: | ||
|
||
```json claude_desktop_config.json | ||
{ | ||
"mcpServers": { | ||
"axiom": { | ||
"command": "PATH_AXIOM_MCP_BINARY", | ||
"env": { | ||
"AXIOM_TOKEN": "PERSONAL_ACCESS_TOKEN", | ||
"AXIOM_URL": "https://AXIOM_DOMAIN", | ||
"AXIOM_ORG_ID": "ORG_ID" | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
<Info> | ||
Replace `PATH_AXIOM_MCP_BINARY` with the path the binary file of the Axiom MCP Server. By default, it’s `~/go/bin/axiom-mcp`. | ||
|
||
Replace `PERSONAL_ACCESS_TOKEN` with the Axiom PAT you have generated. | ||
|
||
<ReplaceDomain /> | ||
|
||
Replace `ORG_ID` with the name of your Axiom organization. For more information, see [Determine organization ID](/reference/tokens#determine-organization-id). | ||
</Info> | ||
|
||
## Ask Claude about your data | ||
|
||
Ask Claude a question about your Axiom data. For example: | ||
|
||
- "List my datasets." | ||
- "Get the data schema for the dataset `logs`." | ||
- "Get the most common status codes in the last 30 minutes in the dataset `logs`." | ||
|
||
For more information about the types of questions the Axiom MCP Server can help you answer, see [Current capabilities](#current-capabilities). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the opposite. API tokens are expected