Skip to content

Commit 6953e19

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore: extract some types in mcp docs
1 parent 8be59d8 commit 6953e19

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

‎packages/mcp-server/src/tools/builds/target-outputs/retrieve-builds-target-outputs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const metadata: Metadata = {
1717
export const tool: Tool = {
1818
name: 'retrieve_builds_target_outputs',
1919
description:
20-
"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 a method to download an output for a given build target.\n\nIf the requested type of output is `source`, and the requested output\nmethod is `url`, a download link to a tarball of the source files is\nreturned. If the requested output method is `git`, a Git remote, ref,\nand access token (if necessary) is returned.\n\nOtherwise, the possible types of outputs are specific to the requested\ntarget, and the output method _must_ be `url`. See the documentation for\n`type` for more information.\n\n# Response Schema\n```json\n{\n anyOf: [ {\n type: 'object',\n properties: {\n output: {\n type: 'string',\n enum: [ 'url'\n ]\n },\n target: {\n $ref: '#/$defs/target'\n },\n type: {\n type: 'string',\n enum: [ 'source',\n 'dist',\n 'wheel'\n ]\n },\n url: {\n type: 'string',\n description: 'URL for direct download'\n }\n },\n required: [ 'output',\n 'target',\n 'type',\n 'url'\n ]\n },\n {\n type: 'object',\n properties: {\n token: {\n type: 'string',\n description: 'Temporary GitHub access token'\n },\n output: {\n type: 'string',\n enum: [ 'git'\n ]\n },\n ref: {\n type: 'string',\n description: 'Git reference (commit SHA, branch, or tag)'\n },\n target: {\n $ref: '#/$defs/target'\n },\n type: {\n type: 'string',\n enum: [ 'source',\n 'dist',\n 'wheel'\n ]\n },\n url: {\n type: 'string',\n description: 'URL to git remote'\n }\n },\n required: [ 'token',\n 'output',\n 'ref',\n 'target',\n 'type',\n 'url'\n ]\n }\n ],\n $defs: {\n target: {\n type: 'string',\n enum: [ 'node',\n 'typescript',\n 'python',\n 'go',\n 'java',\n 'kotlin',\n 'ruby',\n 'terraform',\n 'cli',\n 'php',\n 'csharp'\n ]\n }\n }\n}\n```",
20+
"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 a method to download an output for a given build target.\n\nIf the requested type of output is `source`, and the requested output\nmethod is `url`, a download link to a tarball of the source files is\nreturned. If the requested output method is `git`, a Git remote, ref,\nand access token (if necessary) is returned.\n\nOtherwise, the possible types of outputs are specific to the requested\ntarget, and the output method _must_ be `url`. See the documentation for\n`type` for more information.\n\n# Response Schema\n```json\n{\n $ref: '#/$defs/target_output_retrieve_response',\n $defs: {\n target_output_retrieve_response: {\n anyOf: [ {\n type: 'object',\n properties: {\n output: {\n type: 'string',\n enum: [ 'url'\n ]\n },\n target: {\n $ref: '#/$defs/target'\n },\n type: {\n type: 'string',\n enum: [ 'source',\n 'dist',\n 'wheel'\n ]\n },\n url: {\n type: 'string',\n description: 'URL for direct download'\n }\n },\n required: [ 'output',\n 'target',\n 'type',\n 'url'\n ]\n },\n {\n type: 'object',\n properties: {\n token: {\n type: 'string',\n description: 'Temporary GitHub access token'\n },\n output: {\n type: 'string',\n enum: [ 'git'\n ]\n },\n ref: {\n type: 'string',\n description: 'Git reference (commit SHA, branch, or tag)'\n },\n target: {\n $ref: '#/$defs/target'\n },\n type: {\n type: 'string',\n enum: [ 'source',\n 'dist',\n 'wheel'\n ]\n },\n url: {\n type: 'string',\n description: 'URL to git remote'\n }\n },\n required: [ 'token',\n 'output',\n 'ref',\n 'target',\n 'type',\n 'url'\n ]\n }\n ]\n },\n target: {\n type: 'string',\n enum: [ 'node',\n 'typescript',\n 'python',\n 'go',\n 'java',\n 'kotlin',\n 'ruby',\n 'terraform',\n 'cli',\n 'php',\n 'csharp'\n ]\n }\n }\n}\n```",
2121
inputSchema: {
2222
type: 'object',
2323
properties: {

‎packages/mcp-server/src/tools/orgs/list-orgs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const metadata: Metadata = {
1717
export const tool: Tool = {
1818
name: 'list_orgs',
1919
description:
20-
"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\nList organizations accessible to the current authentication method.\n\n# Response Schema\n```json\n{\n type: 'object',\n properties: {\n data: {\n type: 'array',\n items: {\n $ref: '#/$defs/org'\n }\n },\n has_more: {\n type: 'boolean'\n },\n next_cursor: {\n type: 'string'\n }\n },\n required: [ 'data',\n 'has_more'\n ],\n $defs: {\n org: {\n type: 'object',\n properties: {\n display_name: {\n type: 'string'\n },\n object: {\n type: 'string',\n enum: [ 'org'\n ]\n },\n slug: {\n type: 'string'\n }\n },\n required: [ 'display_name',\n 'object',\n 'slug'\n ]\n }\n }\n}\n```",
20+
"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\nList organizations accessible to the current authentication method.\n\n# Response Schema\n```json\n{\n $ref: '#/$defs/org_list_response',\n $defs: {\n org_list_response: {\n type: 'object',\n properties: {\n data: {\n type: 'array',\n items: {\n $ref: '#/$defs/org'\n }\n },\n has_more: {\n type: 'boolean'\n },\n next_cursor: {\n type: 'string'\n }\n },\n required: [ 'data',\n 'has_more'\n ]\n },\n org: {\n type: 'object',\n properties: {\n display_name: {\n type: 'string'\n },\n object: {\n type: 'string',\n enum: [ 'org'\n ]\n },\n slug: {\n type: 'string'\n }\n },\n required: [ 'display_name',\n 'object',\n 'slug'\n ]\n }\n }\n}\n```",
2121
inputSchema: {
2222
type: 'object',
2323
properties: {

‎packages/mcp-server/src/tools/projects/branches/list-projects-branches.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const metadata: Metadata = {
1717
export const tool: Tool = {
1818
name: 'list_projects_branches',
1919
description:
20-
"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 a project branch by name.\n\n# Response Schema\n```json\n{\n type: 'object',\n properties: {\n data: {\n type: 'array',\n items: {\n type: 'object',\n description: 'A project branch names a line of development for a project. Like a Git\\nbranch, it points to a Git commit with a set of config files. In addition, a\\nproject branch also points to a set of custom code changes, corresponding to\\nGit branches in the staging repos.',\n properties: {\n branch: {\n type: 'string',\n description: 'Branch name'\n },\n config_commit: {\n type: 'object',\n description: 'A Git commit that points to the latest set of config files on a given\\nbranch.',\n properties: {\n repo: {\n type: 'object',\n properties: {\n branch: {\n type: 'string'\n },\n name: {\n type: 'string'\n },\n owner: {\n type: 'string'\n }\n },\n required: [ 'branch',\n 'name',\n 'owner'\n ]\n },\n sha: {\n type: 'string'\n }\n },\n required: [ 'repo',\n 'sha'\n ]\n },\n latest_build_id: {\n type: 'string'\n },\n object: {\n type: 'string',\n enum: [ 'project_branch'\n ]\n },\n org: {\n type: 'string'\n },\n project: {\n type: 'string',\n description: 'Project name'\n }\n },\n required: [ 'branch',\n 'config_commit',\n 'latest_build_id',\n 'object',\n 'org',\n 'project'\n ]\n }\n },\n has_more: {\n type: 'boolean'\n },\n next_cursor: {\n type: 'string'\n }\n },\n required: [ 'data',\n 'has_more'\n ]\n}\n```",
20+
"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 a project branch by name.\n\n# Response Schema\n```json\n{\n type: 'object',\n properties: {\n data: {\n type: 'array',\n items: {\n $ref: '#/$defs/branch_list_response'\n }\n },\n has_more: {\n type: 'boolean'\n },\n next_cursor: {\n type: 'string'\n }\n },\n required: [ 'data',\n 'has_more'\n ],\n $defs: {\n branch_list_response: {\n type: 'object',\n description: 'A project branch names a line of development for a project. Like a Git\\nbranch, it points to a Git commit with a set of config files. In addition, a\\nproject branch also points to a set of custom code changes, corresponding to\\nGit branches in the staging repos.',\n properties: {\n branch: {\n type: 'string',\n description: 'Branch name'\n },\n config_commit: {\n type: 'object',\n description: 'A Git commit that points to the latest set of config files on a given\\nbranch.',\n properties: {\n repo: {\n type: 'object',\n properties: {\n branch: {\n type: 'string'\n },\n name: {\n type: 'string'\n },\n owner: {\n type: 'string'\n }\n },\n required: [ 'branch',\n 'name',\n 'owner'\n ]\n },\n sha: {\n type: 'string'\n }\n },\n required: [ 'repo',\n 'sha'\n ]\n },\n latest_build_id: {\n type: 'string'\n },\n object: {\n type: 'string',\n enum: [ 'project_branch'\n ]\n },\n org: {\n type: 'string'\n },\n project: {\n type: 'string',\n description: 'Project name'\n }\n },\n required: [ 'branch',\n 'config_commit',\n 'latest_build_id',\n 'object',\n 'org',\n 'project'\n ]\n }\n }\n}\n```",
2121
inputSchema: {
2222
type: 'object',
2323
properties: {

‎packages/mcp-server/src/tools/projects/configs/guess-projects-configs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const metadata: Metadata = {
1717
export const tool: Tool = {
1818
name: 'guess_projects_configs',
1919
description:
20-
"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\n\n Generate suggestions for changes to config files based on an OpenAPI spec.\n \n\n# Response Schema\n```json\n{\n type: 'object',\n description: 'Config files contents',\n additionalProperties: true\n}\n```",
20+
"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\n\n Generate suggestions for changes to config files based on an OpenAPI spec.\n \n\n# Response Schema\n```json\n{\n $ref: '#/$defs/config_guess_response',\n $defs: {\n config_guess_response: {\n type: 'object',\n description: 'Config files contents',\n additionalProperties: true\n }\n }\n}\n```",
2121
inputSchema: {
2222
type: 'object',
2323
properties: {

‎packages/mcp-server/src/tools/projects/configs/retrieve-projects-configs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const metadata: Metadata = {
1717
export const tool: Tool = {
1818
name: 'retrieve_projects_configs',
1919
description:
20-
"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\n\n Retrieve the configuration files for a given project.\n \n\n# Response Schema\n```json\n{\n type: 'object',\n description: 'Config files contents',\n additionalProperties: true\n}\n```",
20+
"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\n\n Retrieve the configuration files for a given project.\n \n\n# Response Schema\n```json\n{\n $ref: '#/$defs/config_retrieve_response',\n $defs: {\n config_retrieve_response: {\n type: 'object',\n description: 'Config files contents',\n additionalProperties: true\n }\n }\n}\n```",
2121
inputSchema: {
2222
type: 'object',
2323
properties: {

0 commit comments

Comments
 (0)