get_form
Retrieve details of a specific Tally form by its ID to access form information for management or integration purposes.
Instructions
Retrieve details of a specific Tally form
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| formId | Yes | ID of the form to retrieve |
Implementation Reference
- src/server.ts:1413-1422 (registration)Registration of the 'get_form' tool including its input schema in the _handleToolsList method. This defines the tool's name, description, and expected input (formId).
name: 'get_form', description: 'Retrieve information about a specific Tally form', inputSchema: { type: 'object', properties: { formId: { type: 'string', description: 'ID of the form to retrieve' } }, required: ['formId'] } }, - src/server.ts:1416-1422 (schema)Input schema definition for the 'get_form' tool requiring a formId string.
type: 'object', properties: { formId: { type: 'string', description: 'ID of the form to retrieve' } }, required: ['formId'] } }, - Core implementation of form retrieval via Tally API in TallyApiClient.getForm, which makes the HTTP GET request to /forms/{formId} and validates the response using TallyFormSchema. This is the underlying service method used by tools.
public async getForm(formId: string): Promise<TallyForm> { if (this.isMockEnabled()) { const mockRes = await tallyApiMock.getForm(formId); return mockRes.data; } const url = `/forms/${formId}`; const response = await this.get(url); return validateTallyResponse(TallyFormSchema, response.data); }