basecamp_list_messages
Retrieve and display all messages from a specific Basecamp message board to review project discussions and updates.
Instructions
List messages in a Basecamp message board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bucket_id | Yes | Project/bucket ID | |
| message_board_id | Yes | Message board ID |
Implementation Reference
- src/tools/messages.ts:105-150 (handler)Executes the basecamp_list_messages tool: fetches messages from Basecamp using the client, applies optional regex filter on title/content, serializes relevant fields with serializePerson, returns formatted JSON text content.async (params) => { try { const client = await initializeBasecampClient(); const messages = await asyncPagedToArray({ fetchPage: client.messages.list, request: { params: { bucketId: params.bucket_id, messageBoardId: params.message_board_id, }, query: {}, }, }); // Apply filter if provided let filteredMessages = messages; if (params.filter) { const regex = new RegExp(params.filter, "i"); filteredMessages = messages.filter( (m) => regex.test(m.title) || regex.test(m.content || ""), ); } return { content: [ { type: "text", text: JSON.stringify( filteredMessages.map((m) => ({ id: m.id, title: m.title, creator: serializePerson(m.creator), created_at: m.created_at, })), null, 2, ), }, ], }; } catch (error) { return { content: [{ type: "text", text: handleBasecampError(error) }], }; } },
- src/tools/messages.ts:88-99 (schema)Input schema defining parameters: bucket_id (BasecampIdSchema), message_board_id (BasecampIdSchema), optional filter string for regex matching.inputSchema: { bucket_id: BasecampIdSchema.describe("Project/bucket ID"), message_board_id: BasecampIdSchema.describe("Message board ID"), filter: z .string() .optional() .describe( "Optional regular expression to filter messages by title or content", ), }, annotations: { readOnlyHint: true,
- src/tools/messages.ts:82-151 (registration)Direct registration of the basecamp_list_messages tool using server.registerTool, including title, description, inputSchema, annotations, and handler function.// basecamp_list_messages server.registerTool( "basecamp_list_messages", { title: "List Basecamp Messages", description: `List messages in a Basecamp message board`, inputSchema: { bucket_id: BasecampIdSchema.describe("Project/bucket ID"), message_board_id: BasecampIdSchema.describe("Message board ID"), filter: z .string() .optional() .describe( "Optional regular expression to filter messages by title or content", ), }, annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true, }, }, async (params) => { try { const client = await initializeBasecampClient(); const messages = await asyncPagedToArray({ fetchPage: client.messages.list, request: { params: { bucketId: params.bucket_id, messageBoardId: params.message_board_id, }, query: {}, }, }); // Apply filter if provided let filteredMessages = messages; if (params.filter) { const regex = new RegExp(params.filter, "i"); filteredMessages = messages.filter( (m) => regex.test(m.title) || regex.test(m.content || ""), ); } return { content: [ { type: "text", text: JSON.stringify( filteredMessages.map((m) => ({ id: m.id, title: m.title, creator: serializePerson(m.creator), created_at: m.created_at, })), null, 2, ), }, ], }; } catch (error) { return { content: [{ type: "text", text: handleBasecampError(error) }], }; } }, );
- src/index.ts:62-62 (registration)Invocation of registerMessageTools(server) which registers the basecamp_list_messages among other message tools.registerMessageTools(server);