Skip to main content
Glama
paperinvest

Paper MCP Server

by paperinvest

reset_portfolio

Reset a specified portfolio to its initial state by providing the portfolio ID. Use this to clear all changes and revert to the starting configuration.

Instructions

Reset portfolio to initial state

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portfolioIdYesPortfolio ID to reset

Implementation Reference

  • Handler implementation for the reset_portfolio tool. It performs a POST request to the API endpoint `/accounts/portfolios/${portfolioId}/reset` to reset the portfolio to its initial state.
    case 'reset_portfolio':
      response = await api.post(`/accounts/portfolios/${args.portfolioId}/reset`);
      break;
  • src/index.ts:144-153 (registration)
    Tool registration entry for reset_portfolio, defining its name, description, and input schema (requires portfolioId). This object is part of the tools array returned by ListTools.
      name: 'reset_portfolio',
      description: 'Reset portfolio to initial state',
      inputSchema: {
        type: 'object',
        properties: {
          portfolioId: { type: 'string', description: 'Portfolio ID to reset' }
        },
        required: ['portfolioId']
      }
    },
  • Input schema definition for the reset_portfolio tool, specifying the required portfolioId parameter.
    inputSchema: {
      type: 'object',
      properties: {
        portfolioId: { type: 'string', description: 'Portfolio ID to reset' }
      },
      required: ['portfolioId']
    }
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. 'Reset portfolio to initial state' implies a destructive mutation, but it doesn't specify what gets reset (e.g., positions, cash, settings), whether it's reversible, permission requirements, or side effects. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

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, efficient sentence with no wasted words. It's front-loaded with the core action and target, making it easy to parse quickly. Every word earns its place by conveying essential information without 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 complexity of a destructive reset operation, no annotations, and no output schema, the description is incomplete. It lacks details on what 'initial state' entails, success/failure conditions, return values, or error handling. For a tool that likely alters financial data, more context is needed to ensure safe and correct usage.

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

Parameters4/5

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

The input schema has 1 parameter with 100% coverage, so the schema fully documents 'portfolioId' as a required string. The description doesn't add any parameter-specific details beyond what the schema provides, but with 0 parameters needing extra explanation, a baseline of 4 is appropriate as no compensation is required.

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

Purpose3/5

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

The description 'Reset portfolio to initial state' clearly indicates the action (reset) and target (portfolio), but it's somewhat vague about what 'initial state' means. It doesn't distinguish this tool from potential siblings like 'create_portfolio' or 'update_account' in terms of scope or effect. The purpose is understandable but lacks specificity about what gets reset.

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. It doesn't mention prerequisites (e.g., portfolio must exist), exclusions (e.g., cannot reset while active orders exist), or related tools (e.g., use 'cancel_all_account_orders' first). Without such context, an agent might misuse it in inappropriate scenarios.

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