Skip to content

feat: add optional instructions field to server _oninitialize #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

kalvinnchau
Copy link
Contributor

Add the optional instructions field to the server per the mcp spec

Motivation and Context

Allows setting up initial server instructions

How Has This Been Tested?

Updated the test in src/server/index.test.ts to verify the instruction field is set

Breaking Changes

None

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

Copy link
Member

@jspahrsummers jspahrsummers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Just the one comment.

Comment on lines 266 to 268
private getInstructions(): string | undefined {
return this._instructions;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please remove this? I don't think there's any benefit to a private getter in this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, removed and updated!

Copy link
Member

@jspahrsummers jspahrsummers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thank you!

@jspahrsummers jspahrsummers merged commit f8e5faf into modelcontextprotocol:main Jan 13, 2025
2 checks passed
@Altaflux
Copy link

@kalvinnchau I don't see a way in which clients can get hold of the instructions during connect or at any other point.
Can you clarify how to use this feature from the client side?

@kalvinnchau
Copy link
Contributor Author

@Altaflux this was only server side support, I submitted a pr for client side in #133

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants