Skip to main content

This is a MCP server for Dataeyes

Project description

DataEyes MCP Service

PyPI version License

中文版说明

This project provides an MCP (Machine-Comprehensible Protocol) service powered by DataEyes Intelligence. It exposes a series of tools (e.g., web content reading) to enhance the capabilities of AI Agents.

🤔 What is MCP?

MCP (Machine-Comprehensible Protocol) is a protocol designed for communication between AI Agents and tools. It standardizes how an agent discovers the capabilities of a tool and how it invokes them, enabling seamless integration between different AI systems and services.

✨ Features

  • Standardized Protocol: Fully compatible with the MCP standard for easy integration.
  • Hosted & Self-Hosted Options: Provides a stable, high-performance hosted SSE service and a self-hosted CLI for flexibility.
  • Extensible Toolset: Offers an expanding suite of tools.

🛠️ Available Tools

This service provides a set of tools that can be invoked through the MCP protocol.

📖 reader

The reader tool can access a web page URL and return the main content in a clean, LLM-friendly Markdown format.

Parameters:

  • url (string, required): The URL of the web page to read.
  • timeout (integer, optional, default: 30): The page load timeout in seconds (range: 1-60).

🚀 Getting Started

1. Obtain Your API KEY

An API KEY is required to use the DataEyes services.

Official Website: https://shuyanai.com

Please register and log in to obtain your exclusive API KEY.

2. Choose Your Usage Method

Option A: Hosted SSE Service (Recommended)

This is the easiest way to get started. Just point your AI Agent to our hosted SSE (Server-Sent Events) endpoint.

Endpoint URL:

https://mcp.shuyanai.com/sse?key=YOUR_API_KEY

Remember to replace YOUR_API_KEY with the key you obtained.

Option B: Self-Hosting via CLI

If you prefer to run the server locally, you can install it as a command-line tool.

a. Installation

We recommend using uv to install and run the tool in an isolated environment.

# First, install uv if you don't have it
pip install uv

# Run the server using uvx
uvx dataeyes-mcp-server

b. Environment Variable

For self-hosting, the server reads the API KEY from the DATAEYES_API_KEY environment variable.

  • For macOS/Linux:
    export DATAEYES_API_KEY='your_api_key'
    
  • For Windows:
    setx DATAEYES_API_KEY "your_api_key"
    

Note: You may need to restart your terminal for the changes to take effect.

Once the environment variable is set, you can run uvx dataeyes-mcp-server to start the service, which will communicate via stdio.

📄 License

This project is licensed under the MIT License.

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

dataeyes_mcp_server-1.0.1.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

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

dataeyes_mcp_server-1.0.1-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file dataeyes_mcp_server-1.0.1.tar.gz.

File metadata

  • Download URL: dataeyes_mcp_server-1.0.1.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for dataeyes_mcp_server-1.0.1.tar.gz
Algorithm Hash digest
SHA256 82785d0128a5019364c7efe9e9765f44fcb37def4c739090019b602d4d539467
MD5 88373d029d774fb00e1f691a3b691651
BLAKE2b-256 80439d26ee931e1057cad6ebd9aa16ad885f2f354b89e636e5765a78776f9d92

See more details on using hashes here.

File details

Details for the file dataeyes_mcp_server-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for dataeyes_mcp_server-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3c4797b421c6148633d58ecce0dc604ae45f5e0aeb71421b96eced2158adead0
MD5 1e36f2205db493781521e3f6dbbb9ecc
BLAKE2b-256 0e6698dc22afd25ee0614e443458e626ca738ccd5110404f6a3587300bd39c21

See more details on using hashes here.

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