Skip to main content
Glama
ariesanhthu

VNStock MCP Server

by ariesanhthu

get_company_reports

Retrieve company reports from the Vietnam stock market by providing a stock symbol, with output available in JSON or DataFrame format.

Instructions

Get company reports from stock market
Args:
    symbol: str
    output_format: Literal['json', 'dataframe'] = 'json'
Returns:
    pd.DataFrame

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
symbolYes
output_formatNojson

Implementation Reference

  • The main handler function for the 'get_company_reports' tool, registered via @server.tool() decorator in FastMCP. It retrieves company reports using vnstock's VCICompany API and returns data as JSON or pandas DataFrame based on output_format.
    @server.tool()
    def get_company_reports(
        symbol: str, output_format: Literal["json", "dataframe"] = "json"
    ):
        """
        Get company reports from stock market
        Args:
            symbol: str
            output_format: Literal['json', 'dataframe'] = 'json'
        Returns:
            pd.DataFrame
        """
        equity = VCICompany(symbol=symbol)
        df = equity.reports()
        if output_format == "json":
            return df.to_json(orient="records", force_ascii=False)
        else:
            return df
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It mentions the return type ('pd.DataFrame') but doesn't disclose behavioral traits like data source, rate limits, authentication needs, or what 'company reports' entail (e.g., financial statements, summaries). This leaves significant gaps for a tool with no annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is brief and structured with sections for Args and Returns, making it easy to scan. However, the title is null, and the core purpose statement could be more front-loaded; currently, it's a single sentence followed by details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and low schema coverage, the description is incomplete. It lacks details on what 'company reports' include, how they differ from sibling tools, and behavioral aspects like data freshness or error handling, making it inadequate for a tool in a complex financial context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It lists parameters and their types, adding value beyond the bare schema. However, it doesn't explain what 'symbol' represents (e.g., stock ticker) or clarify the meaning of 'output_format' options, leaving semantics partially unclear.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get') and resource ('company reports from stock market'), making the purpose understandable. However, it doesn't differentiate what type of reports these are compared to siblings like 'get_balance_sheets' or 'get_income_statements', which are more specific report types.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. With many sibling tools for financial data (e.g., get_balance_sheets, get_company_overview), the description lacks context on what makes 'company reports' distinct or when they should be preferred over other report-specific tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ariesanhthu/mcp-server-vietnam-stock-trading'

If you have feedback or need assistance with the MCP directory API, please join our Discord server