get_cash_flow
Retrieve cash flow statements for Chinese companies by stock symbol to analyze financial health and cash management performance in various output formats.
Instructions
获取指定股票代码的公司的现金流量表
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | 股票代码 (例如: '000001') | |
| output_format | No | 输出数据格式: json, csv, xml, excel, markdown, html。默认: markdown | markdown |
Implementation Reference
- src/china_stock_mcp/server.py:358-358 (registration)Registration of the get_cash_flow tool using the @mcp.tool decorator.@mcp.tool(name="get_cash_flow", description="获取指定股票代码的公司的现金流量表")
- src/china_stock_mcp/server.py:359-370 (handler)Handler function that executes the tool logic: fetches cash flow data from akshare_one (ako), handles empty results, and formats the DataFrame output.def get_cash_flow( symbol: Annotated[str, Field(description="股票代码 (例如: '000001')")], output_format: Annotated[ Literal["json", "csv", "xml", "excel", "markdown", "html"], Field(description="输出数据格式: json, csv, xml, excel, markdown, html。默认: markdown"), ] = "markdown" ) -> str: """获取公司现金流量表数据.""" df = ako.get_cash_flow(symbol=symbol, source="sina") if df.empty: df = pd.DataFrame() return _format_dataframe_output(df, output_format)
- Pydantic schema definitions for input parameters (symbol and output_format) using Annotated and Field.symbol: Annotated[str, Field(description="股票代码 (例如: '000001')")], output_format: Annotated[ Literal["json", "csv", "xml", "excel", "markdown", "html"], Field(description="输出数据格式: json, csv, xml, excel, markdown, html。默认: markdown"), ] = "markdown"
- src/china_stock_mcp/server.py:89-118 (helper)Helper function to format the DataFrame output in various formats (json, csv, etc.), used by get_cash_flow and other tools.def _format_dataframe_output( df: pd.DataFrame, output_format: Literal["json", "csv", "xml", "excel", "markdown", "html"], ) -> str: """ 根据指定的格式格式化 DataFrame 输出。 """ if df.empty: return json.dumps([]) if output_format == "json": return df.to_json(orient="records", force_ascii=False) elif output_format == "csv": return df.to_csv(index=False) elif output_format == "xml": return df.to_xml(index=False) elif output_format == "excel": # 使用 BytesIO 将 Excel 写入内存 output = io.BytesIO() df.to_excel(output, index=False, engine='openpyxl') # 返回 base64 编码的二进制数据，或者直接返回字节流 # 为了兼容性，这里尝试返回 utf-8 编码的字符串，但对于二进制文件，通常直接传输字节流更合适 return output.getvalue().decode("utf-8", errors="ignore") elif output_format == "markdown": return df.to_markdown(index=False) elif output_format == "html": return df.to_html(index=False) else: return df.to_json(orient="records", force_ascii=False)