Sharekhan Connect MCP

Sharekhan Connect MCP

](https://badge.fury.io/py/sharekhan-connect-mcp)      

用于Sharekhan交易API的生产就绪模型上下文协议（MCP）服务器，使AI代理能够通过标准化接口执行全面的交易操作。

🚀 快速开始

安装

选择您喜欢的方法：

通过紫外线（推荐）：

uvx install sharekhan-connect-mcp

通过pip：

pip install sharekhan-connect-mcp

来源：

git clone https://github.com/sharekhan-mcp/sharekhan-connect-mcp.git
cd sharekhan-connect-mcp
pip install -e .

配置

1. 获取您的Sharekhan API证书 从 Sharekhan API文档

1. 设置环境变量：

export SHAREKHAN_API_KEY="your_api_key"
export SHAREKHAN_SECRET_KEY="your_secret_key"
export SHAREKHAN_CUSTOMER_ID="your_customer_id"
export SHAREKHAN_VERSION_ID="1005"

1. 运行服务器：

sharekhan-mcp

Claude桌面集成

添加到您的Claude Desktop MCP配置中：

{
  "mcpServers": {
    "sharekhan": {
      "command": "uvx",
      "args": ["sharekhan-connect-mcp"],
      "env": {
        "SHAREKHAN_API_KEY": "your_key",
        "SHAREKHAN_SECRET_KEY": "your_secret",
        "SHAREKHAN_CUSTOMER_ID": "your_id"
      }
    }
  }
}

✨ 特性

• 📈 交易操作：下单、修改和取消订单
• 💼 投资组合管理：访问持有量、头寸和交易历史
• 📊 市场数据：获取实时报价和历史数据
• 🔄 实时更新：用于实时市场馈送的WebSocket集成
• 🔐 安全认证：使用Sharekhan进行基于OAuth的身份验证
• 📊 监控：内置健康检查和绩效指标
• 🤖 AI就绪：AI代理完全支持MCP协议

🛠️ 可用工具

交易操作

• place_order -下达交易订单
• modify_order -修改现有订单
• cancel_order -取消订单

投资组合管理

• get_holdings -检索投资组合持有量
• get_positions -获取交易头寸
• get_orders -访问订单簿
• get_trades -获取交易历史记录

市场数据

• get_historical_data -获取历史市场数据
• get_quote -获取当前市场报价

认证

• authenticate -完成身份验证流程
• get_login_url -生成登录URL

📚 文档

• 快速入门指南 -5分钟设置指南
• 配置指南 -详细的配置选项
• MCP集成 -Claude桌面和MCP客户端设置

🔧 配置

所需的环境变量

SHAREKHAN_API_KEY=your_api_key_here
SHAREKHAN_SECRET_KEY=your_secret_key_here
SHAREKHAN_CUSTOMER_ID=your_customer_id
SHAREKHAN_VERSION_ID=1005  # or 1006, or null

可选配置

SHAREKHAN_VENDOR_KEY=your_vendor_key  # For vendor login
MCP_HOST=0.0.0.0
MCP_PORT=8080
REDIRECT_URI=http://localhost:8080/auth/callback
LOG_LEVEL=INFO

🐳 Docker部署

# Build and run with Docker
docker build -t sharekhan-connect-mcp .
docker run -d \
  --name sharekhan-mcp \
  -p 8080:8080 \
  -e SHAREKHAN_API_KEY=your_key \
  -e SHAREKHAN_SECRET_KEY=your_secret \
  -e SHAREKHAN_CUSTOMER_ID=your_id \
  sharekhan-connect-mcp

🔒 安全

• ✅ 基于令牌的身份验证
• ✅ 使用Pydantic进行输入验证
• ✅ 集中错误处理
• ✅ 结构化日志记录
• ✅ 基于环境的配置
• ✅ 代码中没有凭据

🏗️ 建筑

服务器遵循分层架构：

• MCP协议层 -工具接口和通信
• FastAPI服务器 -HTTP API和请求路由
• 业务逻辑 -交易操作和验证
• 服务层 -API客户端和会话管理
• 基础设施 -配置、记录和监控

📊 监控

内置监控包括：

• 请求指标和性能跟踪
• 系统资源监控（CPU、内存、磁盘）
• 错误跟踪和分类
• API健康检查
• 工具使用分析

🤝 贡献

1. 分叉存储库
2. 创建要素分支(git checkout -b feature/amazing-feature)
3. 提交您的更改(git commit -m 'Add some amazing feature')
4. 推到分支(git push origin feature/amazing-feature)
5. 打开拉取请求

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

🆘 支持

• 配置问题：检查 配置.md
• 设置问题：参见 QUICKSTART.md
• API问题：联系方式 Sharekhan支持
• MCP服务器问题：在此存储库中打开一个问题

⚠️ 重要提示

• 永远不要承诺你的 .env 文件 到版本控制
• 少量测试 首先在沙盒模式下
• 确保API证书的安全
• 监控您的API使用情况 通过Sharekhan的仪表板

🔗 链接

• Sharekhan API文档
• 模型上下文协议
• Claude桌面版

______________________________________________________________________

准备好开始了吗？ 跳转到 QUICKSTART.md 只需5分钟的设置！ 🚀