Get company
twenty_get_companyGet a single company by id. Twenty REST: GET /rest/companies/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The company id. | |
| depth | No | How deep to hydrate related records: 0, 1, or 2. |
twenty_get_companyGet a single company by id. Twenty REST: GET /rest/companies/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The company id. | |
| depth | No | How deep to hydrate related records: 0, 1, or 2. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the read-only nature is known. The description adds the REST endpoint but no further behavioral details (e.g., error handling, depth behavior). It does not contradict the annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, succinct sentence that fully conveys the tool's purpose. No waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple get-by-id tool with full schema coverage and a readOnly annotation, the description is complete. No output schema exists, but the return value (the company) is implied by the operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with both id and depth well-described. The description adds no additional parameter semantics beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool 'Get a single company by id', using a specific verb and resource, and distinguishes from sibling list/create/update tools. It also provides the REST endpoint for clarity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context: use this when you need a single company by ID. It does not explicitly name alternatives like twenty_list_companies for multiple records, but the usage is obvious from the wording.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.