cnhkmcp 1.3.2__py3-none-any.whl → 1.3.4__py3-none-any.whl

cnhkmcp/__init__.py

@@ -50,7 +50,7 @@ from .untracked.forum_functions import (
     read_full_forum_post
 )
 
-__version__ = "1.3.2"
+__version__ = "1.3.4"
 __author__ = "CNHK"
 __email__ = "cnhk@example.com"
 

cnhkmcp/untracked/Alpha_explaination_workflow.md

@@ -0,0 +1,56 @@
+Alpha Explanation Workflow
+This manual provides a step-by-step workflow for analyzing and explaining a WorldQuant BRAIN alpha expression. By following this guide, you can efficiently gather the necessary information to understand the logic and potential strategy behind any alpha.
+
+Step 1: Deconstruct the Alpha Expression
+The first step is to break down the alpha expression into its fundamental components: data fields and operators.
+
+For example, given the expression quantile(ts_regression(oth423_find,group_mean(oth423_find,vec_max(shrt3_bar),country),90)):
+
+Data Fields: oth423_find, shrt3_bar
+Operators: quantile, ts_regression, group_mean, vec_max
+Step 2: Analyze Data Fields
+Use the brain-platform-mcp tool get_datafields to get detailed information about each data field.
+
+Tool Usage: xml <use_mcp_tool> <server_name>brain-platform-mcp</server_name> <tool_name>get_datafields</tool_name> <arguments> { "instrument_type": "EQUITY", "region": "ASI", "delay": 1, "universe": "MINVOL1M", "data_type": "VECTOR", "search": "shrt3_bar" } </arguments> </use_mcp_tool>
+
+Tips for effective searching:
+
+Specify Parameters: Always provide as much information as you know, including instrument_type, region, delay, universe, and data_type (MATRIX or VECTOR).
+Iterate: If you don't find the data field on your first try, try different combinations of parameters. The ASI region, for example, has two universes: MINVOL1M and ILLIQUID_MINVOL1M.
+Check Data Type: Be sure to check if the data is a MATRIX (one value per stock per day) or a VECTOR (multiple values per stock per day). This is crucial for understanding how the data is used.
+Example Data Field Information:
+
+oth423_find: A matrix data field from the "Fundamental Income and Dividend Model" dataset in the ASI region. It represents a "Find score," likely indicating fundamental attractiveness.
+shrt3_bar: A vector data field from the "Securities Lending Files Data" dataset in the ASI region. It provides a vector of ratings (1-10) indicating the demand to borrow a stock, which is a proxy for short-selling interest.
+Step 3: Understand the Operators
+Use the brain-platform-mcp tool get_operators to get a list of all available operators and their descriptions.
+
+Tool Usage: xml <use_mcp_tool> <server_name>brain-platform-mcp</server_name> <tool_name>get_operators</tool_name> <arguments> {} </arguments> </use_mcp_tool> The output of this command contains a wealth of information. For your convenience, a table of the most common operators is included in the Appendix of this manual.
+
+Step 4: Consult Official Documentation
+For more complex topics, the official BRAIN documentation is an invaluable resource. Use the get_documentations tool to see a list of available documents, and get_documentation_page to read a specific page.
+
+Example: To understand vector data fields better, I consulted the "Vector Data Fields 🥉" document (vector-datafields). This revealed that vector data contains multiple values per instrument per day and must be aggregated by a vector operator before being used with other operators.
+
+Step 5: Broaden Understanding with External Research (Must Call the arxiv_api.py script to get the latest research papers)
+For cutting-edge ideas and inspiration, you can search for academic papers on arXiv using the provided arxiv_api.py script.
+
+Workflow:
+
+Identify Keywords: Based on your analysis of the alpha, identify relevant keywords. For our example, these were: "short interest", "fundamental analysis", "relative value", and "news sentiment".
+Run the Script: Use the with-wrappers script to avoid SSL errors.
+
+python arxiv_api.py "your keywords here" -n 10
+Step 6: Synthesize and Explain
+Once you have gathered all the necessary information, structure your explanation in a clear and concise format. The following template is recommended:
+
+Idea: A high-level summary of the alpha's strategy.
+Rationale for data used: An explanation of why each data field was chosen and what it represents.
+Rationale for operators used: A step-by-step explanation of how the operators transform the data to generate the final signal.
+Further Inspiration: Ideas for new alphas based on your research.
+Troubleshooting
+SSL Errors: If you encounter a CERTIFICATE_VERIFY_FAILED error when running python scripts that access the internet, use the AI to help you change or make script to execute your command.
+Appendix A: Understanding Vector Data
+Vector Data is a distinct type of data field where the number of events recorded per day, per instrument, can vary. This is in contrast to standard matrix data, which has a single value for each instrument per day.
+
+For example, news sentiment data is often a vector because a stock can have multiple news articles on a single day. To use this data in most BRAIN operators, it must first be aggregated into a single value using a vector operator.

cnhkmcp/untracked/platform_functions.py

@@ -400,7 +400,7 @@ class BrainApiClient:
     
     async def get_datafields(self, instrument_type: str = "EQUITY", region: str = "USA",
                             delay: int = 1, universe: str = "TOP3000", theme: str = "false",
-                            dataset_id: Optional[str] = None, data_type: str = "MATRIX",
+                            dataset_id: Optional[str] = None, data_type: str = "",
                             search: Optional[str] = None) -> Dict[str, Any]:
         """Get available data fields."""
         await self.ensure_authenticated()
@@ -1683,7 +1683,7 @@ async def get_datafields(
     universe: str = "TOP3000",
     theme: str = "false",
     dataset_id: Optional[str] = None,
-    data_type: str = "MATRIX",
+    data_type: str = "",
     search: Optional[str] = None
 ) -> Dict[str, Any]:
     """

{cnhkmcp-1.3.2.dist-info → cnhkmcp-1.3.4.dist-info}/METADATA

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

cnhkmcp-1.3.4.dist-info/RECORD

@@ -0,0 +1,19 @@
+cnhkmcp/__init__.py,sha256=aw7f1V-8EJO_KkfavII7goZEW922NWSJ1StyrPNC1AA,2758
+cnhkmcp/untracked/Alpha_explaination_workflow.md,sha256=QukeT9gIg4g28AuYPqn-fYtCwb-JmMxZuIkmkrkUfFY,4916
+cnhkmcp/untracked/arXiv_API_Tool_Manual.md,sha256=I3hvI5mpmIjBuWptufoVSWFnuhyUc67oCGHEuR0p_xs,13552
+cnhkmcp/untracked/arxiv_api.py,sha256=-E-Ub9K-DXAYaCjrbobyfQ9H97gaZBc7pL6xPEyVHec,9020
+cnhkmcp/untracked/forum_functions.py,sha256=QW-CplAsqDkw-Wcwq-1tuZBq48dEO-vXZ8xw7X65EuE,42303
+cnhkmcp/untracked/platform_functions.py,sha256=cgF1ZXbLFKt634Bk1OruiO7wmSuDQspdLkSjnpG9aK4,110033
+cnhkmcp/untracked/sample_mcp_config.json,sha256=QSFvZ086bxUQsvmLjcE6pL9ObzKn4FGnt9npWPo7Eps,1044
+cnhkmcp/untracked/user_config.json,sha256=_INn1X1qIsITrmEno-BRlQOAGm9wnNCw-6B333DEvnk,695
+cnhkmcp/untracked/示例参考文档_BRAIN_Alpha_Test_Requirements_and_Tips.md,sha256=W4dtQrqoTN72UyvIsvkGRF0HFOJLHSDeeSlbR3gqQg0,17133
+cnhkmcp/untracked/示例工作流_BRAIN_6_Tips_Datafield_Exploration_Guide.md,sha256=YyMX1MIsDTJTduxulY-fYipNHvRihshQy9Q2j6Zxg2Q,9123
+cnhkmcp/untracked/示例工作流_BRAIN_Alpha_Improvement_Workflow.md,sha256=XlWYREd_qXe1skdXIhkiGY05oDr_6KiBs1WkerY4S8U,5092
+cnhkmcp/untracked/示例工作流_Dataset_Exploration_Expert_Manual.md,sha256=-C4fWdaBe9UzA5BDZz0Do2z8RaPWLslb6D0nTz6fqk4,24403
+cnhkmcp/untracked/示例工作流_daily_report_workflow.md,sha256=SbPZqmIgt8tlRS2NevYQ0t1rvC8uiOqeXorh6nxiXZc,9104
+cnhkmcp-1.3.4.dist-info/licenses/LICENSE,sha256=QLxO2eNMnJQEdI_R1UV2AOD-IvuA8zVrkHWA4D9gtoc,1081
+cnhkmcp-1.3.4.dist-info/METADATA,sha256=_kmLtieDUf6dSWFfP_dgP1AKfdiyG_CPdYUFUGPUrco,5171
+cnhkmcp-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cnhkmcp-1.3.4.dist-info/entry_points.txt,sha256=lTQieVyIvjhSMK4fT-XwnccY-JBC1H4vVQ3V9dDM-Pc,70
+cnhkmcp-1.3.4.dist-info/top_level.txt,sha256=x--ibUcSgOS9Z_RWK2Qc-vfs7DaXQN-WMaaxEETJ1Bw,8
+cnhkmcp-1.3.4.dist-info/RECORD,,

cnhkmcp-1.3.2.dist-info/RECORD

@@ -1,18 +0,0 @@
-cnhkmcp/__init__.py,sha256=tTQO7KVL8mCddCe1P6Eaw7XzhFZWHqYbTCGnmgmw2AU,2758
-cnhkmcp/untracked/BRAIN_6_Tips_Datafield_Exploration_Guide.md,sha256=YyMX1MIsDTJTduxulY-fYipNHvRihshQy9Q2j6Zxg2Q,9123
-cnhkmcp/untracked/BRAIN_Alpha_Improvement_Workflow.md,sha256=XlWYREd_qXe1skdXIhkiGY05oDr_6KiBs1WkerY4S8U,5092
-cnhkmcp/untracked/BRAIN_Alpha_Test_Requirements_and_Tips.md,sha256=W4dtQrqoTN72UyvIsvkGRF0HFOJLHSDeeSlbR3gqQg0,17133
-cnhkmcp/untracked/Dataset_Exploration_Expert_Manual.md,sha256=-C4fWdaBe9UzA5BDZz0Do2z8RaPWLslb6D0nTz6fqk4,24403
-cnhkmcp/untracked/arXiv_API_Tool_Manual.md,sha256=I3hvI5mpmIjBuWptufoVSWFnuhyUc67oCGHEuR0p_xs,13552
-cnhkmcp/untracked/arxiv_api.py,sha256=-E-Ub9K-DXAYaCjrbobyfQ9H97gaZBc7pL6xPEyVHec,9020
-cnhkmcp/untracked/daily_report_workflow.md,sha256=SbPZqmIgt8tlRS2NevYQ0t1rvC8uiOqeXorh6nxiXZc,9104
-cnhkmcp/untracked/forum_functions.py,sha256=QW-CplAsqDkw-Wcwq-1tuZBq48dEO-vXZ8xw7X65EuE,42303
-cnhkmcp/untracked/platform_functions.py,sha256=6GyinE9LpYMfjzdFhdZyIvh2kz4Ovg_RIg5NeUTqIbo,110045
-cnhkmcp/untracked/sample_mcp_config.json,sha256=QSFvZ086bxUQsvmLjcE6pL9ObzKn4FGnt9npWPo7Eps,1044
-cnhkmcp/untracked/user_config.json,sha256=_INn1X1qIsITrmEno-BRlQOAGm9wnNCw-6B333DEvnk,695
-cnhkmcp-1.3.2.dist-info/licenses/LICENSE,sha256=QLxO2eNMnJQEdI_R1UV2AOD-IvuA8zVrkHWA4D9gtoc,1081
-cnhkmcp-1.3.2.dist-info/METADATA,sha256=Ix4Vz75AfgRdnpvdhZvlF4MVq_KH2HEx9XK1qrq439o,5171
-cnhkmcp-1.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cnhkmcp-1.3.2.dist-info/entry_points.txt,sha256=lTQieVyIvjhSMK4fT-XwnccY-JBC1H4vVQ3V9dDM-Pc,70
-cnhkmcp-1.3.2.dist-info/top_level.txt,sha256=x--ibUcSgOS9Z_RWK2Qc-vfs7DaXQN-WMaaxEETJ1Bw,8
-cnhkmcp-1.3.2.dist-info/RECORD,,