Skip to main content
Glama
paperinvest

Paper MCP Server

by paperinvest

get_portfolio_equities

Retrieve all equity positions in a specific portfolio by providing the portfolio ID. Use this tool on the Paper MCP Server to manage and analyze portfolio holdings effectively.

Instructions

Get all equity positions in a portfolio

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portfolioIdYesPortfolio ID

Implementation Reference

  • Handler implementation for the 'get_portfolio_equities' tool. Makes an authenticated API GET request to retrieve all equity positions in the specified portfolio.
    case 'get_portfolio_equities':
      response = await api.get(`/accounts/portfolios/${args.portfolioId}/equities`);
      break;
  • Tool definition including name, description, and input schema for 'get_portfolio_equities'. This is used for both registration (listing tools) and input validation.
    {
      name: 'get_portfolio_equities',
      description: 'Get all equity positions in a portfolio',
      inputSchema: {
        type: 'object',
        properties: {
          portfolioId: { type: 'string', description: 'Portfolio ID' }
        },
        required: ['portfolioId']
      }
    },
  • src/index.ts:388-392 (registration)
    Registration of all tools list handler, which includes 'get_portfolio_equities' via the 'tools' array.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools
      };
    });
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool 'Get[s] all equity positions' but does not clarify if this is a read-only operation, what permissions are needed, how data is returned (e.g., pagination, format), or any rate limits. This leaves significant gaps for a tool that likely interacts with financial data.

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

Conciseness5/5

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

The description is a single, clear sentence with no unnecessary words, making it highly concise and front-loaded. It efficiently communicates the core purpose without any structural issues or redundancy.

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 the lack of annotations and output schema, the description is incomplete for a tool that retrieves financial data. It does not address behavioral aspects like safety, response format, or error handling, which are critical for an AI agent to use this tool effectively in a portfolio management 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?

The input schema has 100% description coverage, with the 'portfolioId' parameter documented as 'Portfolio ID'. The description does not add any meaning beyond this, such as explaining the format of the ID or where to find it. With high schema coverage, the baseline score of 3 is appropriate as the schema handles the parameter documentation adequately.

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 ('all equity positions in a portfolio'), making the purpose specific and understandable. However, it does not explicitly distinguish this tool from sibling tools like 'get_portfolio' or 'get_portfolio_options', which reduces its differentiation value.

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, such as 'get_portfolio' (which might return general portfolio info) or 'get_portfolio_options' (for options positions). There is no mention of prerequisites, exclusions, or specific contexts for usage.

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

Related 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/paperinvest/mcp-server'

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