cnhkmcp 2.1.4__tar.gz → 2.1.6__tar.gz

{cnhkmcp-2.1.4/cnhkmcp.egg-info → cnhkmcp-2.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cnhkmcp
-Version: 2.1.4
+Version: 2.1.6
 Summary: A comprehensive Model Context Protocol (MCP) server for quantitative trading platform integration
 Home-page: https://github.com/cnhk/cnhkmcp
 Author: CNHK

{cnhkmcp-2.1.4 → cnhkmcp-2.1.6}/cnhkmcp/__init__.py

@@ -1,126 +1,126 @@
-"""
-CNHK MCP Server - A comprehensive Model Context Protocol server for quantitative trading platform integration.
-"""
-
-from .untracked.platform_functions import (
-    BrainApiClient,
-    authenticate,
-    create_simulation,
-    get_simulation_status,
-    wait_for_simulation,
-    get_alpha_details,
-    get_datasets,
-    get_datafields,
-    get_alpha_pnl,
-    get_user_alphas,
-    submit_alpha,
-    get_events,
-    get_leaderboard,
-    batch_process_alphas,
-    analyze_alpha_performance,
-    get_operators,
-    run_selection,
-    get_user_profile,
-    get_tutorials,
-    get_messages_summary,
-    get_messages,
-    get_alpha_record_sets,
-    check_production_correlation,
-    check_self_correlation,
-    get_submission_check,
-    set_alpha_properties,
-    get_user_activities,
-    get_pyramid_multipliers,
-    get_pyramid_alphas,
-    get_user_competitions,
-    get_competition_details,
-    get_competition_agreement,
-    get_instrument_options,
-    performance_comparison,
-    combine_test_results,
-    generate_alpha_links,
-    get_tutorial_page,
-    get_tutorial_badge_status
-)
-
-from .untracked.forum_functions import (
-    ForumClient,
-    get_glossary_terms,
-    search_forum_posts,
-    read_full_forum_post
-)
-
-__version__ = "2.1.4"
-__author__ = "CNHK"
-__email__ = "cnhk@example.com"
-
-__all__ = [
-    # Main API client
-    "BrainApiClient",
-    
-    # Authentication
-    "authenticate",
-    
-    # Simulation management
-    "create_simulation",
-    "get_simulation_status",
-    "wait_for_simulation",
-    
-    # Alpha management
-    "get_alpha_details",
-    "submit_alpha",
-    "get_user_alphas",
-    "get_alpha_pnl",
-    "get_alpha_record_sets",
-    "set_alpha_properties",
-    "check_production_correlation",
-    "check_self_correlation",
-    "get_submission_check",
-    
-    # Data access
-    "get_datasets",
-    "get_datafields",
-    "get_operators",
-    "run_selection",
-    "get_instrument_options",
-    
-    # Performance analysis
-    "analyze_alpha_performance",
-    "performance_comparison",
-    "combine_test_results",
-    
-    # User management
-    "get_user_profile",
-    "get_user_activities",
-    "get_user_competitions",
-    
-    # Competition and events
-    "get_events",
-    "get_leaderboard",
-    "get_competition_details",
-    "get_competition_agreement",
-    
-    # Pyramid system
-    "get_pyramid_multipliers",
-    "get_pyramid_alphas",
-    
-    # Tutorials and documentation
-    "get_tutorials",
-    "get_tutorial_page",
-    "get_tutorial_badge_status",
-    
-    # Messages
-    "get_messages_summary",
-    "get_messages",
-    
-    # Utilities
-    "batch_process_alphas",
-    "generate_alpha_links",
-    
-    # Forum functionality
-    "ForumClient",
-    "get_glossary_terms",
-    "search_forum_posts",
-    "read_full_forum_post"
-]
-
+"""
+CNHK MCP Server - A comprehensive Model Context Protocol server for quantitative trading platform integration.
+"""
+
+from .untracked.platform_functions import (
+    BrainApiClient,
+    authenticate,
+    create_simulation,
+    get_simulation_status,
+    wait_for_simulation,
+    get_alpha_details,
+    get_datasets,
+    get_datafields,
+    get_alpha_pnl,
+    get_user_alphas,
+    submit_alpha,
+    get_events,
+    get_leaderboard,
+    batch_process_alphas,
+    analyze_alpha_performance,
+    get_operators,
+    run_selection,
+    get_user_profile,
+    get_tutorials,
+    get_messages_summary,
+    get_messages,
+    get_alpha_record_sets,
+    check_production_correlation,
+    check_self_correlation,
+    get_submission_check,
+    set_alpha_properties,
+    get_user_activities,
+    get_pyramid_multipliers,
+    get_pyramid_alphas,
+    get_user_competitions,
+    get_competition_details,
+    get_competition_agreement,
+    get_instrument_options,
+    performance_comparison,
+    combine_test_results,
+    generate_alpha_links,
+    get_tutorial_page,
+    get_tutorial_badge_status
+)
+
+from .untracked.forum_functions import (
+    ForumClient,
+    get_glossary_terms,
+    search_forum_posts,
+    read_full_forum_post
+)
+
+__version__ = "2.1.6"
+__author__ = "CNHK"
+__email__ = "cnhk@example.com"
+
+__all__ = [
+    # Main API client
+    "BrainApiClient",
+    
+    # Authentication
+    "authenticate",
+    
+    # Simulation management
+    "create_simulation",
+    "get_simulation_status",
+    "wait_for_simulation",
+    
+    # Alpha management
+    "get_alpha_details",
+    "submit_alpha",
+    "get_user_alphas",
+    "get_alpha_pnl",
+    "get_alpha_record_sets",
+    "set_alpha_properties",
+    "check_production_correlation",
+    "check_self_correlation",
+    "get_submission_check",
+    
+    # Data access
+    "get_datasets",
+    "get_datafields",
+    "get_operators",
+    "run_selection",
+    "get_instrument_options",
+    
+    # Performance analysis
+    "analyze_alpha_performance",
+    "performance_comparison",
+    "combine_test_results",
+    
+    # User management
+    "get_user_profile",
+    "get_user_activities",
+    "get_user_competitions",
+    
+    # Competition and events
+    "get_events",
+    "get_leaderboard",
+    "get_competition_details",
+    "get_competition_agreement",
+    
+    # Pyramid system
+    "get_pyramid_multipliers",
+    "get_pyramid_alphas",
+    
+    # Tutorials and documentation
+    "get_tutorials",
+    "get_tutorial_page",
+    "get_tutorial_badge_status",
+    
+    # Messages
+    "get_messages_summary",
+    "get_messages",
+    
+    # Utilities
+    "batch_process_alphas",
+    "generate_alpha_links",
+    
+    # Forum functionality
+    "ForumClient",
+    "get_glossary_terms",
+    "search_forum_posts",
+    "read_full_forum_post"
+]
+

cnhkmcp-2.1.6/cnhkmcp/untracked/brain-consultant.md

@@ -0,0 +1,31 @@
+---
+name: brain-consultant
+description: "when asking questions about worldquant or BRAIN or Alpha research"
+model: inherit
+color: cyan
+---
+You are a WorldQuant BRAIN platform expert also know as BRAIN Consultant. Your expertise includes:
+- Deep knowledge of the BRAIN API, including authentication, data exploration, simulation, and alpha analysis.
+- Expertise in Alpha development, including what makes a good Alpha, what kind of Alphas to submit, and common pitfalls to avoid.
+- Understanding the consultant income structure, including daily pay, the Genius Program, and how to increase earnings.
+
+Instructions:
+- Always refer to the BRAIN_Consultant_Starter_Handbook.md for guidance.
+- When asked about Alphas, emphasize the importance of stable PnL, and economic sense.
+- When asked about the API, follow the workflow outlined in the handbook.
+- When asked about income, explain the different components and how to increase them.
+- Emphasize that I use the brain-platform-mcp to interact with the BRAIN platform and forum.
+
+Domain Knowledge - Pyramid:
+- Definition: "Pyramid" is a platform metric defined as the combination of Region + Delay + Data Category (e.g., USA-D1-analyst). A Pyramid is considered 'lit' when a consultant has submitted at least 3 Alphas in that Region/Delay/Category.
+- Purpose: Pyramids measure diversity and coverage across regions/delays/categories; they factor into promotions, Genius/quarterly programs, and can influence QualityFactor via multipliers.
+- Multipliers: Themes can assign QualityFactor multipliers to pyramids; if multiple themes apply, final multiplier = sum(multipliers) - count_of_themes + 1.
+- Practical tips: target underfilled pyramids for faster 'lighting', use grouping fields required by themes, and track alphaCount and pyramid_multiplier via the MCP API.
+
+Domain Knowledge - Simulation Settings:
+- Overview: Simulation settings define the testing environment for an Alpha. Key fields include instrument_type, region, delay (D0/D1), universe, neutralization, decay, truncation, unit_handling, nan_handling, and test_period. Always confirm the allowed combinations for the chosen instrument and region via the platform settings API before running large tests.
+- Regions & Delay: Common regions are USA, GLB, EUR, ASI, CHN. Delay is typically 0 (D0) or 1 (D1). Some neutralization and universe options differ by region and delay; prefer testing both delays if your strategy depends on intraday vs EOD data.
+- Universes: Typical universes include TOP3000, TOP2000U, TOP2500, TOPSP500, MINVOL1M, ILLIQUID_MINVOL1M and others. Choose one matching your investability goals (broad vs investable/top-tier vs illiquid).
+- Neutralization options (common): NONE, STATISTICAL, REVERSION_AND_MOMENTUM, CROWDING, FAST, SLOW, MARKET, SECTOR, INDUSTRY, SUBINDUSTRY, COUNTRY, SLOW_AND_FAST. Use regression-based neutralization (regression_neut) or group neutralization (group_neutralize) operators when you need explicit factor removal.
+- Operator mappings: For cross-sectional neutralization use regression_neut(y, x) and group_neutralize(x, group); for pre-processing use winsorize, zscore, normalize, then apply neutralization; for time-scale decomposition use ts_* operators and then neutralize by component.
+- Best-practices: Preprocess: winsorize -> zscore/normalize -> regression/group neutralize. Validate: check post-neutralization exposures and self/production correlations. Turnover and investability: measure and tune decay, hump or ts_target_tvr_* operators; test using representative universes. Crowding/RAM: use CROWDING or RAM neutralization options when you want to reduce overlaps with crowded signals; validate PnL change and turnover.