Skip to main content
Glama
ariesanhthu

VNStock MCP Server

by ariesanhthu
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

get_company_insider_deals

Retrieve insider trading data for Vietnam-listed companies to analyze executive and major shareholder transactions.

Instructions

Get company insider deals 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

  • src/vnstock_mcp/server.py:199-216 (handler)
    The handler function decorated with @server.tool(), which registers and implements the 'get_company_insider_deals' tool. It retrieves insider deals for a given company symbol using the vnstock library's TCBSCompany and returns the data in JSON or DataFrame format.
    @server.tool()
def get_company_insider_deals(
    symbol: str, output_format: Literal["json", "dataframe"] = "json"
):
    """
    Get company insider deals from stock market
    Args:
        symbol: str
        output_format: Literal['json', 'dataframe'] = 'json'
    Returns:
        pd.DataFrame
    """
    equity = TCBSCompany(symbol=symbol)
    df = equity.insider_deals()
    if output_format == "json":
        return df.to_json(orient="records", force_ascii=False)
    else:
        return df

Tool Definition Quality

C2.9/5.0
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 lacks critical behavioral details: whether this is a read-only operation, if it requires authentication, rate limits, data freshness, or error handling. For a financial data tool with zero annotation coverage, this is a significant gap.

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 efficiently structured with a clear purpose statement followed by Args and Returns sections. Every sentence adds value, though the formatting could be slightly improved for readability (e.g., bullet points).

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 0% schema description coverage, the description is incomplete. It covers parameters but misses behavioral context (e.g., safety, performance) and doesn't fully explain return values beyond the type. For a tool fetching financial data, more guidance is needed.

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%, but the description compensates by documenting both parameters: 'symbol' (with type 'str') and 'output_format' (with enum values and default). However, it doesn't explain what 'symbol' represents (e.g., stock ticker) or the implications of choosing 'json' vs 'dataframe', leaving some ambiguity.

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 verb 'Get' and resource 'company insider deals from stock market', which is specific and actionable. However, it doesn't distinguish this tool from potential siblings like get_company_officers or get_company_shareholders that might also provide insider-related data, keeping it from a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives. With many sibling tools available (e.g., get_company_overview, get_company_news), there's no indication of context, prerequisites, or exclusions for selecting this specific tool for insider deals.

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