Skip to main content
Glama
daanno

Simplicate MCP Server

by daanno

get_document

Retrieve specific documents from Simplicate business data using document IDs to access CRM records, project files, timesheets, and invoices.

Instructions

Get specific document by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYes

Implementation Reference

  • MCP tool handler for 'get_document' that validates the document_id parameter and delegates to SimplicateServiceExtended.getDocumentById, returning JSON-formatted result.
    case 'get_document': {
      if (!toolArgs.document_id) throw new Error('document_id is required');
      const data = await this.simplicateService.getDocumentById(toolArgs.document_id);
      return { content: [{ type: 'text', text: JSON.stringify(data, null, 2) }] };
    }
  • Tool registration in ListTools handler, including name, description, and input schema definition.
    {
      name: 'get_document',
      description: 'Get specific document by ID',
      inputSchema: {
        type: 'object',
        properties: { document_id: { type: 'string' } },
        required: ['document_id'],
      },
    },
  • Core service method that fetches the document by ID from the Simplicate API endpoint `/documents/document/{documentId}`.
    async getDocumentById(documentId: string): Promise<SimplicateDocument> {
      const response = await this.client.get(`/documents/document/${documentId}`);
      return response.data;
    }
  • Input schema defining the required 'document_id' string parameter for the tool.
      inputSchema: {
        type: 'object',
        properties: { document_id: { type: 'string' } },
        required: ['document_id'],
      },
    },
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. 'Get' implies a read operation, but there's no information about authentication requirements, rate limits, error handling, or what happens if the document doesn't exist. The description doesn't mention whether this is a safe operation or has any side effects.

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 extremely concise at just 5 words, front-loading the essential information with zero wasted words. Every word earns its place by specifying the action, resource, and key parameter requirement.

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?

For a tool with no annotations, 0% schema description coverage, and no output schema, the description is inadequate. It doesn't explain what a 'document' means in this context, what information is returned, or how this tool fits into the broader system with many sibling tools. The agent would struggle to use this effectively without additional context.

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

Parameters2/5

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

The input schema has 0% description coverage, providing only a parameter name with no semantic meaning. The description mentions 'by ID' which clarifies that 'document_id' should be an identifier, but doesn't explain what format the ID should be, where to obtain it, or provide any examples. This adds minimal value beyond the bare schema.

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 ('specific document by ID'), making the purpose immediately understandable. It distinguishes from sibling 'get_documents' by specifying retrieval of a single document rather than a list. However, it doesn't specify what type of document or from what system, leaving some ambiguity.

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 like 'get_documents' for listing multiple documents or other get_* tools for different resources. There's no mention of prerequisites, error conditions, or contextual factors that would help an agent choose between this and sibling 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/daanno/simplicate-mcp'

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