@codeqr/ts-mcp 0.2.1

package/src/tools/links/retrieve-info-links.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { maybeFilter } from '@codeqr/ts-mcp/filtering';
+import { Metadata, asTextContentResult } from '@codeqr/ts-mcp/tools/types';
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import Codeqr from '@codeqr/ts';
+
+export const metadata: Metadata = {
+  resource: 'links',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/links/info',
+  operationId: 'getLinkInfo',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_info_links',
+  description:
+    "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nRetrieve the info for a link.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/link',\n  $defs: {\n    link: {\n      type: 'object',\n      title: 'Link',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'The unique ID of the short link.'\n        },\n        android: {\n          type: 'string',\n          description: 'The Android destination URL for the short link for Android device targeting.'\n        },\n        archived: {\n          type: 'boolean',\n          description: 'Whether the short link is archived.'\n        },\n        clicks: {\n          type: 'number',\n          description: 'The number of clicks on the short link.'\n        },\n        comments: {\n          type: 'string',\n          description: 'The comments for the short link.'\n        },\n        createdAt: {\n          type: 'string',\n          description: 'The date and time when the short link was created.'\n        },\n        description: {\n          type: 'string',\n          description: 'The description of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.'\n        },\n        doIndex: {\n          type: 'boolean',\n          description: 'Whether search engines can index the short link.'\n        },\n        domain: {\n          type: 'string',\n          description: 'The domain of the short link. If not provided, the main domain of the project will be used (or `codeqr.link` if the project has no domains).'\n        },\n        expiredUrl: {\n          type: 'string',\n          description: 'The URL to redirect to when the short link expires.'\n        },\n        expiresAt: {\n          type: 'string',\n          description: 'The date and time when the short link will expire in ISO-8601 format. Must be in the future.'\n        },\n        externalId: {\n          type: 'string',\n          description: 'This is the ID of the link in your database.'\n        },\n        filled: {\n          type: 'boolean',\n          description: 'Whether the link is filled or not.'\n        },\n        flexible: {\n          type: 'boolean',\n          description: 'Whether the short link is flexible.'\n        },\n        geo: {\n          type: 'object',\n          description: 'Geographic targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo',\n          additionalProperties: true\n        },\n        image: {\n          type: 'string',\n          description: 'The image of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.'\n        },\n        ios: {\n          type: 'string',\n          description: 'The iOS destination URL for the short link for iOS device targeting.'\n        },\n        isFormMandatory: {\n          type: 'boolean',\n          description: 'If the form is mandatory for the page.'\n        },\n        key: {\n          type: 'string',\n          description: 'The slug of the short link. If not provided, a random 7-character slug will be generated.'\n        },\n        lastClicked: {\n          type: 'string',\n          description: 'The date and time when the short link was last clicked.'\n        },\n        leads: {\n          type: 'number',\n          description: 'The number of leads generated by the short link.'\n        },\n        notificationToken: {\n          type: 'string',\n          description: 'The notification token of the short link.'\n        },\n        password: {\n          type: 'string',\n          description: 'The password required to access the short link destination URL.'\n        },\n        preRedirection: {\n          type: 'boolean',\n          description: 'Whether the short link has pre-redirection.'\n        },\n        projectId: {\n          type: 'string',\n          description: 'The ID of the project of the short link.'\n        },\n        proxy: {\n          type: 'boolean',\n          description: 'Whether the short link uses the custom link preview feature.'\n        },\n        publicStats: {\n          type: 'boolean',\n          description: 'Whether the short link statistics are publicly accessible.'\n        },\n        rewrite: {\n          type: 'boolean',\n          description: 'Whether the short link uses link cloaking.'\n        },\n        saleAmount: {\n          type: 'number',\n          description: 'The amount of the sale generated by the link.'\n        },\n        sales: {\n          type: 'number',\n          description: 'The number of sales generated by the short link.'\n        },\n        tagId: {\n          type: 'string',\n          description: '[DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned to the short link.'\n        },\n        tags: {\n          type: 'array',\n          description: 'The tags assigned to the short link.',\n          items: {\n            $ref: '#/$defs/tag'\n          }\n        },\n        title: {\n          type: 'string',\n          description: 'The title of the short link generated via `api.codeqr.io/metatags`. Will be used for custom link preview if `proxy` is true.'\n        },\n        trackConversion: {\n          type: 'boolean',\n          description: '[BETA] Whether to track conversions for the short link.'\n        },\n        updatedAt: {\n          type: 'string',\n          description: 'The date and time when the short link was last updated.'\n        },\n        url: {\n          type: 'string',\n          description: 'The destination URL of the short link.'\n        },\n        userId: {\n          type: 'string',\n          description: 'The ID of the user who created the short link.'\n        },\n        utm_campaign: {\n          type: 'string',\n          description: 'The UTM campaign of the short link.'\n        },\n        utm_content: {\n          type: 'string',\n          description: 'The UTM content of the short link.'\n        },\n        utm_medium: {\n          type: 'string',\n          description: 'The UTM medium of the short link.'\n        },\n        utm_source: {\n          type: 'string',\n          description: 'The UTM source of the short link.'\n        },\n        utm_term: {\n          type: 'string',\n          description: 'The UTM term of the short link.'\n        },\n        video: {\n          type: 'string',\n          description: 'The video of the short link.'\n        },\n        pageId: {\n          type: 'string',\n          description: 'The ID of the page to redirect to before the link destination.'\n        },\n        pageUrl: {\n          type: 'string',\n          description: 'The URL of the page to redirect to before the link destination.'\n        },\n        qrCode: {\n          type: 'string',\n          description: 'The complete QR code URL for the short link (for example, `https://api.codeqr.io/qr?url=https://codeqr.link/try`).'\n        },\n        shortLink: {\n          type: 'string',\n          description: 'The complete URL of the short link, including the https protocol (for example, `https://codeqr.link/try`).'\n        }\n      },\n      required: [        'id',\n        'android',\n        'archived',\n        'clicks',\n        'comments',\n        'createdAt',\n        'description',\n        'doIndex',\n        'domain',\n        'expiredUrl',\n        'expiresAt',\n        'externalId',\n        'filled',\n        'flexible',\n        'geo',\n        'image',\n        'ios',\n        'isFormMandatory',\n        'key',\n        'lastClicked',\n        'leads',\n        'notificationToken',\n        'password',\n        'preRedirection',\n        'projectId',\n        'proxy',\n        'publicStats',\n        'rewrite',\n        'saleAmount',\n        'sales',\n        'tagId',\n        'tags',\n        'title',\n        'trackConversion',\n        'updatedAt',\n        'url',\n        'userId',\n        'utm_campaign',\n        'utm_content',\n        'utm_medium',\n        'utm_source',\n        'utm_term',\n        'video'\n      ]\n    },\n    tag: {\n      type: 'object',\n      title: 'Tag',\n      properties: {\n        id: {\n          type: 'string',\n          description: 'The unique ID of the tag.'\n        },\n        color: {\n          type: 'string',\n          description: 'The color of the tag.',\n          enum: [            'red',\n            'yellow',\n            'green',\n            'blue',\n            'purple',\n            'pink',\n            'brown'\n          ]\n        },\n        name: {\n          type: 'string',\n          description: 'The name of the tag.'\n        }\n      },\n      required: [        'id',\n        'color',\n        'name'\n      ]\n    }\n  }\n}\n```",
+  inputSchema: {
+    type: 'object',
+    properties: {
+      domain: {
+        type: 'string',
+        description:
+          'The domain of the link to be retrieved. For example, for `codeqr.link/github`, the domain is `codeqr.link`.',
+      },
+      key: {
+        type: 'string',
+        description:
+          'The key of the link to be retrieved. For example, for `codeqr.link/github`, the key is `github`.',
+      },
+      projectSlug: {
+        type: 'string',
+        description:
+          'The slug of the project to which the link belongs. For example, for `app.codeqr.io/acme`, the projectSlug is `acme`.',
+      },
+      externalId: {
+        type: 'string',
+        description:
+          'This is the ID of the link in your database. Must be prefixed with `ext_` when passed as a query parameter.',
+      },
+      linkId: {
+        type: 'string',
+        description: 'The unique ID of the short link.',
+      },
+      jq_filter: {
+        type: 'string',
+        title: 'jq Filter',
+        description:
+          'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+      },
+    },
+    required: ['domain', 'key', 'projectSlug'],
+  },
+  annotations: {
+    readOnlyHint: true,
+  },
+};
+
+export const handler = async (client: Codeqr, args: Record<string, unknown> | undefined) => {
+  const { jq_filter, ...body } = args as any;
+  return asTextContentResult(await maybeFilter(jq_filter, await client.links.retrieveInfo(body)));
+};
+
+export default { metadata, tool, handler };