Skip to main content

Add your description here

Project description

tuskr-mcp-server

Implements a Model Context Protocol (MCP) server for the Tuskr REST API

Built on the FastMCP Python SDK.
Supports access token authentication.

Installation

Environment variables / .env file

Set up environment variables or configure the .env file using the .env.example template.

The following environment variables are supported:

TUSKR_ACCOUNT_ID=<your account id>
TUSKR_ACCESS_TOKEN=<your access token>

(this doc desc https://tuskr.app/kb/latest/api)

and optionally

MCP_TRANSPORT=<transport type: http or stdio>
MCP_HOST=<host for HTTP transport>
MCP_PORT=<port for HTTP transport>

Command Line Parameters

The MCP server supports the following command line parameters:

  • --transport: Transport type for the MCP server. Options: http (default) or stdio
  • --host: Host address for HTTP transport (default: 0.0.0.0)
  • --port: Port number for HTTP transport (default: 8000)

Note: The --host and --port parameters are only applicable when using the http transport.

Default Values

  • Transport: http (can be overridden with MCP_TRANSPORT environment variable)
  • Host: 0.0.0.0 (can be overridden with MCP_HOST environment variable)
  • Port: 8000 (can be overridden with MCP_PORT environment variable)

Connect from client

HTTP Transport (Default)

Use the following template to connect the server via HTTP:

{
  "mcpServers": {
    "tuskr": {
      "transport": "http",
      "url": "http://<your-mcp-dns-or-ip>/mcp/",
      "headers": {
        "Authorization": "Bearer <your access token>",
        "Account-ID": "<your-tuskr-account-id>"
      }
    }
  }
}

The Authorization is mandatory.

The Account-ID is not required and can be set on the server side using the TUSKR_ACCOUNT_ID env variable. It's convenient in case you have single MCP Server for organization.

stdio Transport (for local development)

For local development and integration with tools like uvx, use the stdio transport:

{
  "mcpServers": {
    "tuskr": {
      "transport": "stdio",
      "command": "uvx",
      "args": ["tuskr-mcp-server", "--transport", "stdio"]
    }
  }
}

or use uv with source code:

{
  "mcpServers": {
    "tuskr": {
      "transport": "stdio",
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/your/tuskr-mcp-server",
        "run",
        "src/main.py",
        "--transport",
        "stdio"
      ]
    }
  }
}

Development

Setup

  1. Clone repo
  2. Install development dependencies: uv sync --dev
  3. Create .env from .env.example

Running MCP service

HTTP Transport (Default)

uv run --env-file .env src/main.py

stdio Transport (for local development)

uv run --env-file .env src/main.py --transport stdio

Custom Host/Port

uv run --env-file .env src/main.py --host 127.0.0.1 --port 9000

Running tests

The project uses pytest for testing. The following command will run all tests

uv run pytest -vsx

Running linters

The project uses the ruff tool as a linter.

The following command allows to run linter

uv run ruff check

and this command allow to fix formatting

uv run ruff format

Dockerization

The following command allows to build a docker image

docker build -t tuskr-mcp .

and then you can run it using the

docker run -it tuskr-mcp

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

tuskr_mcp_server-0.1.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

tuskr_mcp_server-0.1.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file tuskr_mcp_server-0.1.1.tar.gz.

File metadata

  • Download URL: tuskr_mcp_server-0.1.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tuskr_mcp_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b8db90942410ade078184b72e996bbfa9bd8c42210454b4e8f954c73fa219038
MD5 b036c83bdc760296c97c028ec1dd1123
BLAKE2b-256 f1f4dcc1490f49cb733529106f297d0c5ef6f1010ca7292fd82f9aa3c90b2115

See more details on using hashes here.

Provenance

The following attestation bundles were made for tuskr_mcp_server-0.1.1.tar.gz:

Publisher: publish.yml on BoomBidiBuyBuy/tuskr-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tuskr_mcp_server-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for tuskr_mcp_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dfed27da87925c902c26aa460edec575e145ee2917066a2fac76a4c7047622f2
MD5 fc54e527d5e8effbca58cf8984b33a9e
BLAKE2b-256 da95f65137d73eaf4e0ad281df6c2e6b63c66a9709ac64f34c14cd24ba165363

See more details on using hashes here.

Provenance

The following attestation bundles were made for tuskr_mcp_server-0.1.1-py3-none-any.whl:

Publisher: publish.yml on BoomBidiBuyBuy/tuskr-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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