Skip to main content
Glama

Lovie Company Formation

Get Period

accounting_get_period
Read-only

GetPeriod returns one closed period by id. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
periodIdYesUUID value wrapper.
companyIdYesUUID value wrapper.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
periodNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / period / anyOf
      Added value: +[
      +  {
      +    "properties": {
      +      "closedAt": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "closedBy": {
      +        "anyOf": [
      +          {
      +            "description": "UUID value wrapper.",
      +            "properties": {
      +              "value": {
      +                "format": "uuid",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "companyId": {
      +        "anyOf": [
      +          {
      +            "description": "UUID value wrapper.",
      +            "properties": {
      +              "value": {
      +                "format": "uuid",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "createdAt": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "currencies": {
      +        "items": {
      +          "properties": {
      +            "closingEntryId": {
      +              "anyOf": [
      +                {
      +                  "description": "UUID value wrapper.",
      +                  "properties": {
      +                    "value": {
      +                      "format": "uuid",
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "currencyCode": {
      +              "type": "string"
      +            },
      +            "netIncome": {
      +              "type": "string"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "type": "array"
      +      },
      +      "granularity": {
      +        "enum": [
      +          "PERIOD_GRANULARITY_UNSPECIFIED",
      +          "PERIOD_GRANULARITY_MONTH",
      +          "PERIOD_GRANULARITY_QUARTER",
      +          "PERIOD_GRANULARITY_YEAR"
      +        ],
      +        "type": "string"
      +      },
      +      "id": {
      +        "anyOf": [
      +          {
      +            "description": "UUID value wrapper.",
      +            "properties": {
      +              "value": {
      +                "format": "uuid",
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "periodEnd": {
      +        "type": "string"
      +      },
      +      "periodStart": {
      +        "type": "string"
      +      },
      +      "status": {
      +        "enum": [
      +          "ACCOUNTING_PERIOD_STATUS_UNSPECIFIED",
      +          "ACCOUNTING_PERIOD_STATUS_OPEN",
      +          "ACCOUNTING_PERIOD_STATUS_CLOSED"
      +        ],
      +        "type": "string"
      +      },
      +      "updatedAt": {
      +        "anyOf": [
      +          {
      +            "format": "date-time",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "companyId"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / period / properties
      Removed value: -{
      -  "closedAt": {
      -    "format": "date-time",
      -    "type": "string"
      -  },
      -  "closedBy": {
      -    "description": "UUID value wrapper.",
      -    "properties": {
      -      "value": {
      -        "format": "uuid",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "companyId": {
      -    "description": "UUID value wrapper.",
      -    "properties": {
      -      "value": {
      -        "format": "uuid",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "createdAt": {
      -    "format": "date-time",
      -    "type": "string"
      -  },
      -  "currencies": {
      -    "items": {
      -      "properties": {
      -        "closingEntryId": {
      -          "description": "UUID value wrapper.",
      -          "properties": {
      -            "value": {
      -              "format": "uuid",
      -              "type": "string"
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "currencyCode": {
      -          "type": "string"
      -        },
      -        "netIncome": {
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  "granularity": {
      -    "enum": [
      -      "PERIOD_GRANULARITY_UNSPECIFIED",
      -      "PERIOD_GRANULARITY_MONTH",
      -      "PERIOD_GRANULARITY_QUARTER",
      -      "PERIOD_GRANULARITY_YEAR"
      -    ],
      -    "type": "string"
      -  },
      -  "id": {
      -    "description": "UUID value wrapper.",
      -    "properties": {
      -      "value": {
      -        "format": "uuid",
      -        "type": "string"
      -      }
      -    },
      -    "type": "object"
      -  },
      -  "periodEnd": {
      -    "type": "string"
      -  },
      -  "periodStart": {
      -    "type": "string"
      -  },
      -  "status": {
      -    "enum": [
      -      "ACCOUNTING_PERIOD_STATUS_UNSPECIFIED",
      -      "ACCOUNTING_PERIOD_STATUS_OPEN",
      -      "ACCOUNTING_PERIOD_STATUS_CLOSED"
      -    ],
      -    "type": "string"
      -  },
      -  "updatedAt": {
      -    "format": "date-time",
      -    "type": "string"
      -  }
      -}
    • removedOutput schema / properties / period / required
      Removed value: -[
      -  "companyId"
      -]
    • removedOutput schema / properties / period / type
      Removed value: -"object"
  2. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already provide readOnlyHint=true and destructiveHint=false, so the phrase 'Read-only' adds no new safety information. The description does add a useful behavioral constraint—only closed periods are returned—but it gives no further context about missing periods, auth requirements, or error behavior. With annotations present, this is adequate but not rich.

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 core information is front-loaded in one clear sentence: 'returns one closed period by id.' The second sentence, 'Read-only,' repeats the annotation, and the description begins with the tool name, which prevents a 5, but there is no unnecessary padding.

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

Completeness4/5

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

For a simple two-parameter get-by-id tool with an output schema and read-only annotations, the description supplies the essential selection constraint (closed period) and is sufficient for calling the tool. It could add more context about when to prefer it over the list-periods tool, but that gap is largely an usage-guidance issue.

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 100%, so the schema already documents the UUID wrapper shapes for companyId and periodId. The phrase 'by id' loosely maps to periodId, but the description does not add additional meaning beyond what the input schema and parameter names already convey.

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

Purpose5/5

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

The description states a specific operation: 'returns one closed period by id,' with a clear resource (closed period) and identifier. This distinguishes it from siblings like accounting_get_list_periods, which retrieves multiple periods, and from write tools like accounting_reopen_period.

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

Usage Guidelines3/5

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

The description implies the tool is for fetching a single closed period by id, but it does not explicitly state when to use it over accounting_get_list_periods or mention exclusions such as open periods. There is no guidance about alternatives or prerequisites beyond the tool name and schema.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.